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

Link to correct documentation page which describes the docstrings style #294

Open
ashwinvis opened this issue Sep 12, 2024 · 0 comments
Open

Comments

@ashwinvis
Copy link

In the section In-code documentation — How to document your research software documentation it reads

Read more: https://peps.python.org/pep-0257/

although the PEP does not specify any particular format or convention for parsing Python docstrings. The same problem exists for other languages. It could be a good idea to add one more link for further reading:

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

No branches or pull requests

1 participant