Links naming api with coding guidelines.

This commit is contained in:
Grzegorz Adam Hankiewicz
2014-04-21 14:39:50 +02:00
parent 61ded5ab60
commit d89918ab46
2 changed files with 11 additions and 2 deletions

View File

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

View File

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