Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Developer Documentation #83

Open
thealphadollar opened this issue Sep 18, 2018 · 0 comments
Open

Improve Developer Documentation #83

thealphadollar opened this issue Sep 18, 2018 · 0 comments
Labels
bug Something isn't working Coding Documentation/Training enhancement New feature or request GCI18 Tasks for Google Code In 2018 good first issue Good for newcomers Quality Assurance urgent

Comments

@thealphadollar
Copy link
Owner

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

@thealphadollar thealphadollar added bug Something isn't working enhancement New feature or request good first issue Good for newcomers urgent GCI Tasks for Google Code In Quality Assurance Coding GCI18 Tasks for Google Code In 2018 and removed GCI Tasks for Google Code In labels Sep 18, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working Coding Documentation/Training enhancement New feature or request GCI18 Tasks for Google Code In 2018 good first issue Good for newcomers Quality Assurance urgent
Projects
None yet
Development

No branches or pull requests

1 participant