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.

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

Implement an autoformatter for docstrings #1668

Open
namurphy opened this issue Aug 12, 2022 · 1 comment
Open

Implement an autoformatter for docstrings #1668

namurphy opened this issue Aug 12, 2022 · 1 comment
Labels
docs PlasmaPy Docs at http://docs.plasmapy.org priority: low Issues & PRs of low urgency and importance that may be deferred until later Python Lv2 | Intermediate Issues that require a medium amount of knowledge of Python status: on hold Issues & PRs that are being intentionally delayed

Comments

@namurphy
Copy link
Member

We use the numpydoc standard for our docstrings, there is still some inconsistency in the formatting (e.g., whether or not there's a blank line after a section header or if there are blank lines between parameters). Consistent formatting makes documentation easier to read or skim, but it would be very tedious and error-prone to consistentify the formatting manually. It would be helpful to apply an autoformatter for our docstrings, in particular as a pre-commit hook.

I tried a few docstring autoformatters a few months ago but had some issues getting them to work, like if the one-liner was more than one line, or if numpydoc wasn't supported. I'm not sure if there's a docstring autoformatter that fits our needs yet and is well-maintained.

@namurphy namurphy added the docs PlasmaPy Docs at http://docs.plasmapy.org label Aug 12, 2022
@namurphy
Copy link
Member Author

namurphy commented Aug 15, 2022

Some of the ones I've looked into before but haven't tried recently:

@namurphy namurphy added priority: low Issues & PRs of low urgency and importance that may be deferred until later Python Lv2 | Intermediate Issues that require a medium amount of knowledge of Python labels Aug 18, 2022
@github-actions github-actions bot added the Stale Dormant issues & PRs which will be automatically closed if the label is not removed. label Oct 18, 2022
@namurphy namurphy removed the Stale Dormant issues & PRs which will be automatically closed if the label is not removed. label May 12, 2023
@namurphy namurphy added the status: on hold Issues & PRs that are being intentionally delayed label Oct 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs PlasmaPy Docs at http://docs.plasmapy.org priority: low Issues & PRs of low urgency and importance that may be deferred until later Python Lv2 | Intermediate Issues that require a medium amount of knowledge of Python status: on hold Issues & PRs that are being intentionally delayed
Projects
None yet
Development

No branches or pull requests

1 participant