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

Add documentation for the code #37

Open
tanmaymunjal opened this issue Jul 23, 2023 · 0 comments
Open

Add documentation for the code #37

tanmaymunjal opened this issue Jul 23, 2023 · 0 comments
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@tanmaymunjal
Copy link
Contributor

The code is largely undocumented due to being built out quickly by a small team with very high context about the codebase.

The few docstrings that exist are either not clear or mostly changed functionality.

Makes sense to add documentation, also prob increase and update function docstring documentation and add a CI step to automatically generate the html docs generated from it.

This issue was created at https://www.defi-os.com, please login/signup on it to get cash rewards for solving it.

@tanmaymunjal tanmaymunjal added enhancement New feature or request help wanted Extra attention is needed labels Jul 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant