From f7a0a42b05ee5e5181e3c8b8dab66586f374dbab Mon Sep 17 00:00:00 2001 From: Timothee Cour Date: Tue, 5 Feb 2019 17:45:30 -0800 Subject: [PATCH] fixup --- doc/contributing.rst | 4 ++-- doc/docstyle.rst | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/contributing.rst b/doc/contributing.rst index d71e39ce23..c240cb80ed 100644 --- a/doc/contributing.rst +++ b/doc/contributing.rst @@ -26,7 +26,7 @@ There are 3 types of tests: 2. tests in ``when isMainModule:`` block, ran by ``nim c mymod.nim`` ``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 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 To run a single test: diff --git a/doc/docstyle.rst b/doc/docstyle.rst index fdd395b5ef..f0785bc0a3 100644 --- a/doc/docstyle.rst +++ b/doc/docstyle.rst @@ -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. ## - ## .. code-block:: Nim + ## .. code-block:: ## 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 ## truncating the result. ## - ## .. code-block:: nim + ## .. code-block:: ## # things that aren't suitable for a `runnableExamples` go in code-block: ## echo execCmdEx("git pull") ## drawOnScreen()