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.

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 PEP 257 compliance. #39

Closed
pierrepo opened this issue Dec 23, 2020 · 1 comment · Fixed by #62
Closed

Improve PEP 257 compliance. #39

pierrepo opened this issue Dec 23, 2020 · 1 comment · Fixed by #62
Assignees
@HubLot @patrickfuchs

Comments

@pierrepo
Copy link
Collaborator

We should improve docstrings PEP 257 compliance. Especially for one-line docstrings.

We could use pydocstyle for this. pydocstyle is already installed in the conda environement (see binder/environment.yml).
@HubLot HubLot mentioned this issue Dec 23, 2020
Closed
@HubLot HubLot self-assigned this Dec 23, 2020
@patrickfuchs patrickfuchs self-assigned this Dec 23, 2020
@patrickfuchs
Copy link
Owner

I'd say that https://python.sdv.univ-paris-diderot.fr/15_bonnes_pratiques/#152-les-docstrings-et-la-pep-257 is worth a read 😉
Note: since the beginning, I decided to use the NumPy style for docstrings.
I can also clean them up, so I also assigned myself to this issue.

@HubLot HubLot linked a pull request Jan 19, 2021 that will close this issue
Improve PEP8 and PEP257 compliance #62
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@HubLot HubLot

@patrickfuchs patrickfuchs

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve PEP8 and PEP257 compliance HubLot/buildH
3 participants
@pierrepo @HubLot @patrickfuchs