jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fixup

Browse source
This commit is contained in:
Timothee Cour 2019-02-05 17:45:30 -08:00
commit f7a0a42b05
2 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

4
doc/contributing.rst
View file

@ -26,7 +26,7 @@ There are 3 types of tests:
2. tests in ``when isMainModule:`` block, ran by ``nim c mymod.nim`` 2. tests in ``when isMainModule:`` block, ran by ``nim c mymod.nim``
``nimble test`` also typially runs these in external nimble packages. ``nimble test`` also typially runs these in external nimble packages.
3. testament tests, eg: tests/stdlib/tos.nim (only used for Nim repo). 3. testament tests, eg: ``tests/stdlib/tos.nim`` (only used for Nim repo).
Not all the tests follow the convention here, feel free to change the ones Not all the tests follow the convention here, feel free to change the ones
that don't. Always leave the code cleaner than you found it. that don't. Always leave the code cleaner than you found it.
@ -118,7 +118,7 @@ list of these, see ``testament/categories.nim``, at the bottom.
:: ::
./koch tests c lib # compiles/runs stdlib modules, including ``isMainModule`` tests ./koch tests c lib # compiles/runs stdlib modules, including `isMainModule` tests
./koch tests c megatest # runs a set of tests that can be combined into 1 ./koch tests c megatest # runs a set of tests that can be combined into 1
To run a single test: To run a single test:

4
doc/docstyle.rst
View file

@ -27,7 +27,7 @@ Code samples are encouraged, and should follow the general RST syntax:
## The `universe` module computes the answer to life, the universe, and everything. ## The `universe` module computes the answer to life, the universe, and everything.
## ##
## .. code-block:: Nim ## .. code-block::
## doAssert computeAnswerString() == 42 ## doAssert computeAnswerString() == 42
@ -62,7 +62,7 @@ Whenever an example of usage would be helpful to the user, you should include on
## Adds three `int8` values, treating them as unsigned and ## Adds three `int8` values, treating them as unsigned and
## truncating the result. ## truncating the result.
## ##
## .. code-block:: nim ## .. code-block::
## # things that aren't suitable for a `runnableExamples` go in code-block: ## # things that aren't suitable for a `runnableExamples` go in code-block:
## echo execCmdEx("git pull") ## echo execCmdEx("git pull")
## drawOnScreen() ## drawOnScreen()