Review code documentation
marfox opened this issue · comments
- README - update workflow with Makefile instructions
- complete README
- function docstrings
@e-dorigatti, what is the status of the docstrings?
I committed some descriptions about most of the scripts that we have, except for the verb ranking part as I didn't really know what to write. Is it enough?
That's okay for the header docstrings, but can you document the function docstrings as well please?
@e-dorigatti, let me know when I can close this one.
@marfox you can close this.
Hey @e-dorigatti , it would be best to add field lists to docstrings.
In this way, we can generate proper documentation sites using modules like Sphinx.
See also http://docutils.sourceforge.net/docs/user/rst/quickref.html and http://docs.python-guide.org/en/latest/writing/documentation/