hummingbot
hummingbot copied to clipboard
Add more documentation to the hummingbot source code
Hummingbot is an open source project and we want to welcome collaboration from outside the company.
- Module level (top of each .py .pyx file) comments explaining the purpose of the file.
- Function/method level comments.
- Use pydoc to allow user to output it in a readable format. Think about hosting the output pydoc somewhere. https://docs.python.org/3/library/pydoc.html
- Use the interrogate package to ensure a certain level of documentation https://interrogate.readthedocs.io/en/latest/
┆Issue is synchronized with this Clickup task by Unito