CODE REVIEW: DOCUMENTATION

[bramiozo]

Documentation is a prerequisite for using, developing and reviewing the program. Here are some things to check for.

• (yes) Is there a description of the purpose of the program or library? Perhaps handy to place the latest version of the ec2mor3 paper in the code lib?
• (yes) Are detailed requirements listed?
• (no) Are requirements ranked according to MoSCoW? (must-haves, should-haves, could-haves, would-haves)
• (not the purpose/use) Is the use and function of third-party libraries documented?
• (there is no schematic overview) Is the structure/architecture of the program documented? Perhaps nice to add a simple diagram next in your Design section of the readme?
• [x ] (yes) Is there an installation manual?
• (there are examples but there is no user manual) Is there a user manual?
• (no) Is there documentation on how to contribute?
• (no) Including how to submit changes
• (no) Including how to document your changes
• (no) Are function/classes documented following PEP8? For small function, just state the purpose

	```Returns bla
	Description:
		blabla
	Input variables:
		varname, vartype; description
	Output:
		varname, vartype, description
	```

[zklaus]

@bramiozo This looks like some very useful ideas! Given that the development has progressed almost to the finishing line, I think it would make sense to focus a bit more on the user documentation.
Do you think you could help with that?

[treerink]

Note that @goord is also planning to write a describing paper (with us), and in that process there will be additional effort on all level documentation.