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

Update nep1 to show type keyword on its own line

Browse source
This commit is contained in:
Dominik Picheta 2017-03-15 21:48:46 +01:00 • committed by GitHub
commit 19c436ab20
1 changed files with 16 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

12
doc/nep1.rst
View file

@ -81,7 +81,8 @@ changed in the future.
var aVariable = "Meep" var aVariable = "Meep"
type FooBar = object type
FooBar = object
For constants coming from a C/C++ wrapper, ALL_UPPERCASE are allowed, but ugly. For constants coming from a C/C++ wrapper, ALL_UPPERCASE are allowed, but ugly.
(Why shout CONSTANT? Constants do no harm, variables do!) (Why shout CONSTANT? Constants do no harm, variables do!)
@ -99,12 +100,14 @@ changed in the future.
- Exception and Error types should have the "Error" suffix. - Exception and Error types should have the "Error" suffix.
.. code-block:: nim .. code-block:: nim
type UnluckyError = object of Exception type
UnluckyError = object of Exception
- Unless marked with the `{.pure.}` pragma, members of enums should have an - Unless marked with the `{.pure.}` pragma, members of enums should have an
identifying prefix, such as an abbreviation of the enum's name. identifying prefix, such as an abbreviation of the enum's name.
.. code-block:: nim .. code-block:: nim
type PathComponent = enum type
PathComponent = enum
pcDir pcDir
pcLinkToDir pcLinkToDir
pcFile pcFile
@ -113,7 +116,8 @@ changed in the future.
PascalCase. PascalCase.
.. code-block:: nim .. code-block:: nim
type PathComponent {.pure.} = enum type
PathComponent {.pure.} = enum
Dir Dir
LinkToDir LinkToDir
File File