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

fix RST parsing when no indent after enum.item (fix #17249) (#17257)

Browse source
This commit is contained in:
Andrey Makarov 2021-03-12 10:33:21 +03:00 • committed by GitHub
commit d97bf4f1c8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 82 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

20
doc/contributing.rst
View file

@ -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.