cadey
/
nim-wiki
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Internal docs improvements

This commit is contained in:
Dominik Picheta 2014-02-13 06:33:57 -08:00
parent 8e07e53725
commit 6610e60735
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
GSoC-2014-Ideas.md
View File

@ -167,10 +167,17 @@ The [Nimrod documentation](http://nimrod-lang.org/lib.html) is generally good bu
___
#### Add documentation to the Nimrod compiler internals
**Desirable skills:** Basic writing and documentation skills.
**Desirable skills:** Basic writing and documentation skills, knowledge of how compilers function.
**Description:**
There is currently very little documentation about the way the Nimrod compiler functions. This means that it is difficult for newcomers to contribute to the compiler. This is not helped by the fact that the compiler source code is seldom commented.
This project aims to improve this situation. You will be tasked with describing how the compiler is structured, the stages of the compilation process etc. You will also be expected to read the source of the compiler and try to explain what the code does using comments where appropriate. Guides on how to debug the compiler would also be welcome.
**Tasks**:
* Add comments to the compiler internals, documenting the various mechanisms and mechanics the compiler uses to analyze and transform nimrod code to the code of the specified backend.
* Write documentation describing the architecture of the compiler.
**Difficulty:** Medium