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

Fix python docstrings for sphinx #9

Open

7 tasks

dajuno opened this issue Apr 28, 2022 · 0 comments

Labels

Contributor

dajuno commented Apr 28, 2022

Issue description:

sphinx assumes that python docstrings are written in restructuredtext format, which differs slightly from markdown. I quite like the google style for docstrings: https://github.com/google/styleguide/blob/gh-pages/pyguide.md#38-comments-and-docstrings

TODOS:

agree on docstring style
adapt docstrings accordingly & be consistent in the future

Checklist for this issue:

Assignee has been set for this issue
All fields of the issue have been filled
Issue has been assigned to the main project
Code was merged
Feature branch has been deleted and issues were updated / closed

dajuno added the enhancement label

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