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

Format docstrings as required #56

Open
clorton opened this issue Sep 30, 2024 · 1 comment
Open

Format docstrings as required #56

clorton opened this issue Sep 30, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@clorton
Copy link
Contributor

clorton commented Sep 30, 2024

https://docs.idmod.org/projects/doc-guidance/en/latest/docstrings.html

@clorton clorton added the documentation Improvements or additions to documentation label Sep 30, 2024
@jonathanhhb
Copy link
Collaborator

I've spent some time formatting doc strings lately and it's my observation that so-called numpy-style doc string seems to render best in a pdf (and also probably html) after being processed by sphinx. I imagine google style should also work if you have the right plugins but it wasn't that way for me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants