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.

Sign up for GitHub

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

Jump to bottom

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

Commits on Aug 15, 2024

  1. refactor: 🗑️ Deprecate "add_header_to_table"

    @teald
    teald committed Aug 15, 2024
    Configuration menu
    Copy the full SHA
    99435fa View commit details
    Browse the repository at this point in the history

  2. docs: ✍️ State deprecation of add_header_to_table in summary

    @teald
    teald committed Aug 15, 2024
    Configuration menu
    Copy the full SHA
    405e7f2 View commit details
    Browse the repository at this point in the history

  3. docs: ✍️ Update docstring for descriptor decorator.

    @teald
    teald committed Aug 15, 2024
    Configuration menu
    Copy the full SHA
    25a0ea2 View commit details
    Browse the repository at this point in the history

  4. docs: ✍️ Update astro_data_tag documentation.

    @teald
    teald committed Aug 15, 2024
    Configuration menu
    Copy the full SHA
    85d79a8 View commit details
    Browse the repository at this point in the history

  5. docs: ✍️ Update returns_list documentation.

    @teald
    teald committed Aug 15, 2024
    Configuration menu
    Copy the full SHA
    5428ee9 View commit details
    Browse the repository at this point in the history

  6. docs(api): ✍️ Update from_file documentation

    @teald
    teald committed Aug 15, 2024
    Configuration menu
    Copy the full SHA
    11d7390 View commit details
    Browse the repository at this point in the history

  7. docs(api): ✍️ Update open docstring

    @teald
    teald committed Aug 15, 2024
    Configuration menu
    Copy the full SHA
    a94c37a View commit details
    Browse the repository at this point in the history

  8. docs: 👷 Add nox, install help.

    @teald
    teald committed Aug 15, 2024
    Configuration menu
    Copy the full SHA
    530715f View commit details
    Browse the repository at this point in the history

  9. docs: ✍️ Unify and expand on docstrings in AstoData

    @teald
    teald committed Aug 15, 2024
    Configuration menu
    Copy the full SHA
    aa5d6de View commit details
    Browse the repository at this point in the history

  10. docs: ✍️ Unify and update nddata.py docs

    @teald
    teald committed Aug 15, 2024
    Configuration menu
    Copy the full SHA
    601fdc3 View commit details
    Browse the repository at this point in the history

  11. docs: ✍️ Update and unify docstrings for utils.

    @teald
    teald committed Aug 15, 2024
    Configuration menu
    Copy the full SHA
    e993718 View commit details
    Browse the repository at this point in the history

  12. docs: ✍️ Add examples and clarification to Section

    @teald
    teald committed Aug 15, 2024
    Configuration menu
    Copy the full SHA
    b710437 View commit details
    Browse the repository at this point in the history

  13. docs: 🧹 Fix docstring lint errors

    @teald
    teald committed Aug 15, 2024
    Configuration menu
    Copy the full SHA
    7b5dc4c View commit details
    Browse the repository at this point in the history

  14. docs: ✍️ Fix linting errors for fits.py

    @teald
    teald committed Aug 15, 2024
    Configuration menu
    Copy the full SHA
    b5dd4b5 View commit details
    Browse the repository at this point in the history

  15. docs: ✍️ Rename Parameters to Arguments in docstrings

    @teald
    teald committed Aug 15, 2024
    Configuration menu
    Copy the full SHA
    2d7600b View commit details
    Browse the repository at this point in the history

  16. docs: 🧹 Fix docstirng lint errors.

    @teald
    teald committed Aug 15, 2024
    Configuration menu
    Copy the full SHA
    58b3ac1 View commit details
    Browse the repository at this point in the history

  17. docs: 🎨 Change Parameters to Arguments in docstring

    @teald
    teald committed Aug 15, 2024
    Configuration menu
    Copy the full SHA
    946abb9 View commit details
    Browse the repository at this point in the history

  18. docs: 🧹 Fix testing docstring lint errors.

    @teald
    teald committed Aug 15, 2024
    Configuration menu
    Copy the full SHA
    2d1c5d9 View commit details
    Browse the repository at this point in the history

  19. ci(lint): ✨ Add documentation style rules to linter

    @teald
    teald committed Aug 15, 2024
    Configuration menu
    Copy the full SHA
    b5be873 View commit details
    Browse the repository at this point in the history

  20. docs: 🧹 Fix wcs docstring lint errors.

    @teald
    teald committed Aug 15, 2024
    Configuration menu
    Copy the full SHA
    c521369 View commit details
    Browse the repository at this point in the history

  21. docs: 🧹 Change Parameter to Arguments in docstrings

    @teald
    teald committed Aug 15, 2024
    Configuration menu
    Copy the full SHA
    d58f18e View commit details
    Browse the repository at this point in the history

  22. docs: 🧹 Fix provenance docstring lint errors.

    @teald
    teald committed Aug 15, 2024
    Configuration menu
    Copy the full SHA
    d6a17b6 View commit details
    Browse the repository at this point in the history

  23. docs: 🧹 Fix docstring lint errors.

    @teald
    teald committed Aug 15, 2024
    Configuration menu
    Copy the full SHA
    729bf18 View commit details
    Browse the repository at this point in the history

  24. docs: ✍️ Add information to package docstring.

    @teald
    teald committed Aug 15, 2024
    Configuration menu
    Copy the full SHA
    d968cad View commit details
    Browse the repository at this point in the history

  25. docs: 🧹 Change Parameters to Arguments where lingering.

    @teald
    teald committed Aug 15, 2024
    Configuration menu
    Copy the full SHA
    17db9c1 View commit details
    Browse the repository at this point in the history

  26. docs: 🚨 Fix line length problems.

    @teald
    teald committed Aug 15, 2024
    Configuration menu
    Copy the full SHA
    5e0740e View commit details
    Browse the repository at this point in the history