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

Links naming api with coding guidelines.

Browse source
This commit is contained in:
Grzegorz Adam Hankiewicz 2014-04-21 14:39:50 +02:00
commit d89918ab46
2 changed files with 11 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

7
doc/apis.txt
View file

@ -79,3 +79,10 @@ string str
identifier ident identifier ident
indentation indent indentation indent
------------------- ------------ -------------------------------------- ------------------- ------------ --------------------------------------
Coding Guidelines
=================
For coding guidelines see the `Internals of the Nimrod Compiler
<intern.html#coding-guidelines>`_ documentation.

6
doc/intern.txt
View file

@ -69,8 +69,10 @@ Coding Guidelines
* Max line length is 80 characters. * Max line length is 80 characters.
* Provide spaces around binary operators if that enhances readability. * Provide spaces around binary operators if that enhances readability.
* Use a space after a colon, but not before it. * Use a space after a colon, but not before it.
* Start types with a capital ``T``, unless they are pointers/references which start * Start types with a capital ``T``, unless they are pointers/references which
with ``P``. start with ``P``.
See also the `API naming design <apis.html>`_ document.
Porting to new platforms Porting to new platforms