diff options
author | Andrey Makarov <ph.makarov@gmail.com> | 2021-03-12 10:33:21 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-03-12 08:33:21 +0100 |
commit | d97bf4f1c80ef41789ecfc3430e04293d2b20043 (patch) | |
tree | d72e80c79d4fcd1757107cad251a2ed32ee2c327 /doc | |
parent | 97825805e047ae02003dfd2ed4c0bb3d0d9dc29a (diff) | |
download | Nim-d97bf4f1c80ef41789ecfc3430e04293d2b20043.tar.gz |
fix RST parsing when no indent after enum.item (fix #17249) (#17257)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/contributing.rst | 20 | ||||
-rw-r--r-- | doc/manual.rst | 15 |
2 files changed, 19 insertions, 16 deletions
diff --git a/doc/contributing.rst b/doc/contributing.rst index e6301faae..ba9c1caf3 100644 --- a/doc/contributing.rst +++ b/doc/contributing.rst @@ -599,14 +599,16 @@ to existing modules is acceptable. For two reasons: Conventions ----------- -1. New stdlib modules should go under `Nim/lib/std/`. The rationale is to require -users to import via `import std/foo` instead of `import foo`, which would cause -potential conflicts with nimble packages. Note that this still applies for new modules -in existing logical directories, e.g.: -use `lib/std/collections/foo.nim`, not `lib/pure/collections/foo.nim`. +1. New stdlib modules should go under `Nim/lib/std/`. The rationale is to + require users to import via `import std/foo` instead of `import foo`, + which would cause potential conflicts with nimble packages. + Note that this still applies for new modules in existing logical + directories, e.g.: use `lib/std/collections/foo.nim`, + not `lib/pure/collections/foo.nim`. 2. New module names should prefer plural form whenever possible, e.g.: -`std/sums.nim` instead of `std/sum.nim`. In particular, this reduces chances of conflicts -between module name and the symbols it defines. Furthermore, module names should -use `snake_case` and not use capital letters, which cause issues when going -from an OS without case sensitivity to an OS with it. + `std/sums.nim` instead of `std/sum.nim`. In particular, this reduces + chances of conflicts between module name and the symbols it defines. + Furthermore, module names should use `snake_case` and not use capital + letters, which cause issues when going from an OS without case + sensitivity to an OS with it. diff --git a/doc/manual.rst b/doc/manual.rst index ba7ef5059..4686247d2 100644 --- a/doc/manual.rst +++ b/doc/manual.rst @@ -6073,13 +6073,14 @@ avoid ambiguity when there are multiple modules with the same path. There are two pseudo directories: -1. ``std``: The ``std`` pseudo directory is the abstract location of Nim's standard -library. For example, the syntax ``import std / strutils`` is used to unambiguously -refer to the standard library's ``strutils`` module. -2. ``pkg``: The ``pkg`` pseudo directory is used to unambiguously refer to a Nimble -package. However, for technical details that lie outside the scope of this document, -its semantics are: *Use the search path to look for module name but ignore the standard -library locations*. In other words, it is the opposite of ``std``. +1. ``std``: The ``std`` pseudo directory is the abstract location of + Nim's standard library. For example, the syntax ``import std / strutils`` + is used to unambiguously refer to the standard library's ``strutils`` module. +2. ``pkg``: The ``pkg`` pseudo directory is used to unambiguously refer to + a Nimble package. However, for technical details that lie outside the + scope of this document, its semantics are: *Use the search path to look for + module name but ignore the standard library locations*. + In other words, it is the opposite of ``std``. From import statement |