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.

Sign up for GitHub

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

Jump to bottom

improve documentation for methods #7

Open

alastair opened this issue Jan 15, 2020 · 0 comments

Member

alastair commented Jan 15, 2020

There are a lot of issues with the documentation currently:

A lot of documentation for methods is obviously copied from a different method and the description and arguments weren't updated
Many docstrings are missing descriptions for some arguments
A huge number of spelling mistakes

These should all be cleaned up and unified so that we can generate documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment