diff --git a/doc/apis.txt b/doc/apis.txt index 165279490e..9906f6bbcc 100644 --- a/doc/apis.txt +++ b/doc/apis.txt @@ -79,3 +79,10 @@ string str identifier ident indentation indent ------------------- ------------ -------------------------------------- + + +Coding Guidelines +================= + +For coding guidelines see the `Internals of the Nimrod Compiler +`_ documentation. diff --git a/doc/intern.txt b/doc/intern.txt index 52b1af1904..ec6db8709f 100644 --- a/doc/intern.txt +++ b/doc/intern.txt @@ -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 `_ document. Porting to new platforms