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

Update API docstrings #50

Merged
merged 26 commits into from
Aug 16, 2024
Merged

Update API docstrings #50

merged 26 commits into from
Aug 16, 2024

Conversation

teald
Copy link
Member

@teald teald commented Aug 14, 2024

Summary

This PR updates documentation for the API functions and classes, including examples where necessary.

Documentation changes

  • Unify Parameters -> Arguments in docstrings
  • Add Examples as appropriate
    • Not explicitly requested, but this is extra insurance against documentation/example changes
  • Imperative mood for summary line
  • Single-line summary lines
  • Specify "numpy" convention for linting in pyproject.toml

Other changes

  • Deprecate add_header_to_table, as its implementation is no longer used in astrodata and is not recommended.

Notes

@teald teald added documentation Improvements or additions to documentation maintenance For maintenance tasks labels Aug 14, 2024
@teald teald self-assigned this Aug 14, 2024
@teald teald force-pushed the docs/update_api_docstrings branch from d008675 to 8bd4c24 Compare August 15, 2024 19:29
@teald teald force-pushed the docs/update_api_docstrings branch from c30261b to 17db9c1 Compare August 15, 2024 22:24
@teald teald marked this pull request as ready for review August 15, 2024 22:34
@teald teald merged commit 77f57d4 into main Aug 16, 2024
14 checks passed
@teald teald deleted the docs/update_api_docstrings branch August 16, 2024 17:00
@teald teald added the PyOpenSci Review Part of a PyOpenSci Review label Aug 22, 2024
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant