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

Convert all docstrings to numpy style #278

Closed
vyasr opened this issue Mar 25, 2020 · 4 comments · Fixed by #392
Closed

Convert all docstrings to numpy style #278

vyasr opened this issue Mar 25, 2020 · 4 comments · Fixed by #392
Assignees
@y4shb
Labels
blocked Dependent on something else documentation Writing or editing documentation enhancement New feature or request

Comments

@vyasr
Copy link
Contributor

vyasr commented Mar 25, 2020

As part of our overall docs overhaul (see glotzerlab/signac-docs#64), we want to convert our docstrings to numpy style (as decided in glotzerlab/signac-docs#74). The best automated tool I'm familiar with for this task is pyment. In addition to converting docstrings, it will also generate docstrings for functions, classes, etc that are missing docstrings entirely. However, the conversion will require significant manual review to ensure that all docstrings are converted correctly.
@vyasr vyasr added enhancement New feature or request documentation Writing or editing documentation labels Mar 25, 2020
@vyasr
Copy link
Contributor Author

vyasr commented Mar 30, 2020

@CryoZEUS could you comment on this issue so that I can assign you?

@y4shb
Copy link
Contributor

y4shb commented Mar 30, 2020

Yeah, I'd love to work on it.

@vyasr vyasr mentioned this issue Mar 31, 2020
Closed
@y4shb y4shb mentioned this issue Jul 4, 2020
Closed
12 tasks
@b-butler b-butler added the blocked Dependent on something else label Aug 20, 2020
@b-butler
Copy link
Member

We should revisit this after GSoC. We will likely need someone else to move #316 to completion.

@bdice bdice mentioned this issue Dec 9, 2020
Merged
9 tasks
@bdice
Copy link
Member

bdice commented Jan 20, 2021

Resolved by #392.

@bdice bdice closed this as completed Jan 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@y4shb y4shb

Labels
blocked Dependent on something else documentation Writing or editing documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Use NumPy style docstrings. glotzerlab/signac-flow
4 participants
@vyasr @bdice @y4shb @b-butler