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

Documentation convention #2

Open

apetros opened this issue Apr 14, 2019 · 0 comments

apetros commented Apr 14, 2019 •

edited

Loading

The documentation convention used for the functions is very strange and doesn’t give enough information.

Please follow the proper convention as shown here: https://www.datacamp.com/community/tutorials/docstrings-python

I use the Sphinx convention but it’s up to you.

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