-
Notifications
You must be signed in to change notification settings - Fork 2
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
Update API docstrings #50
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
teald
added
documentation
Improvements or additions to documentation
maintenance
For maintenance tasks
labels
Aug 14, 2024
teald
force-pushed
the
docs/update_api_docstrings
branch
from
August 15, 2024 19:29
d008675
to
8bd4c24
Compare
teald
force-pushed
the
docs/update_api_docstrings
branch
from
August 15, 2024 22:24
c30261b
to
17db9c1
Compare
32 tasks
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
maintenance
For maintenance tasks
PyOpenSci Review
Part of a PyOpenSci Review
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR updates documentation for the API functions and classes, including examples where necessary.
Documentation changes
Parameters
->Arguments
in docstringsExamples
as appropriatepyproject.toml
Other changes
add_header_to_table
, as its implementation is no longer used inastrodata
and is not recommended.Notes