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

Improve docstrings for functions and classes #1619

Open
VeckoTheGecko opened this issue Jul 26, 2024 · 0 comments
Open

Improve docstrings for functions and classes #1619

VeckoTheGecko opened this issue Jul 26, 2024 · 0 comments
Labels

Comments

@VeckoTheGecko
Copy link
Contributor

The API reference for Parcels is a great way to understand how to use individual functions. Some of the functions/classes don't have documentation as the Python docstring is empty, meaning that users either have to look at documentation notebooks for examples, or look at the code itself. It would be good to update these docstrings with a description or (if more appropriate/easier) update the docstring with a link to the best tutorial to learn about said function.

If linking to a documentation notebook make sure to use the https://.../latest/.... link rather than tying to a version so that if the link is broken in future we can have that picked up by our automations.

@VeckoTheGecko VeckoTheGecko converted this from a draft issue Jul 26, 2024
@VeckoTheGecko VeckoTheGecko pinned this issue Jul 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Backlog
Development

No branches or pull requests

1 participant