From 6610e607354c6b2912380dacc2d1a9fc86de7c50 Mon Sep 17 00:00:00 2001 From: Dominik Picheta Date: Thu, 13 Feb 2014 06:33:57 -0800 Subject: [PATCH] Internal docs improvements --- GSoC-2014-Ideas.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/GSoC-2014-Ideas.md b/GSoC-2014-Ideas.md index 63ffb0c..6af854f 100644 --- a/GSoC-2014-Ideas.md +++ b/GSoC-2014-Ideas.md @@ -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