-
Notifications
You must be signed in to change notification settings - Fork 11
Improve Developer Documentation #83
Copy link
Copy link
Open
Labels
CodingDocumentation/TrainingGCI18Tasks for Google Code In 2018Tasks for Google Code In 2018Quality AssurancebugSomething isn't workingSomething isn't workingenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomersurgent
Metadata
Metadata
Assignees
Labels
CodingDocumentation/TrainingGCI18Tasks for Google Code In 2018Tasks for Google Code In 2018Quality AssurancebugSomething isn't workingSomething isn't workingenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomersurgent
Describe the bug
The current developer's documentation is not sufficient and lacks at many levels.
To Reproduce
None
Expected behavior
Developer documentation should contain per page all the function doc-strings and also the list of global variables used. There should be (but not necessarily) link to the side effects of the function which will be present on a different page.
Screenshots
None
Additional context
The current documentation was generated using PyDoc. Below are a few resources to try out different methods of the generation of documentation from docstrings. The best part is that it will automatically follow the folder schema.
https://python-docs.readthedocs.io/en/latest/writing/documentation.html
https://stackoverflow.com/questions/26587763/how-to-generate-documentation-using-pydoc