summary refs log tree commit diff stats
path: root/doc
diff options
context:
space:
mode:
authorTimothee Cour <timothee.cour2@gmail.com>2019-02-05 17:45:30 -0800
committerTimothee Cour <timothee.cour2@gmail.com>2019-02-05 17:45:30 -0800
commitf7a0a42b05ee5e5181e3c8b8dab66586f374dbab (patch)
treebce4682a8666bf0be2c48fa474053ee245543932 /doc
parent86f4dae74831125bb0b9fae6f59b480169a0b52f (diff)
downloadNim-f7a0a42b05ee5e5181e3c8b8dab66586f374dbab.tar.gz
fixup
Diffstat (limited to 'doc')
-rw-r--r--doc/contributing.rst4
-rw-r--r--doc/docstyle.rst4
2 files changed, 4 insertions, 4 deletions
diff --git a/doc/contributing.rst b/doc/contributing.rst
index d71e39ce2..c240cb80e 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 fdd395b5e..f0785bc0a 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()