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

Convert all docstrings to numpy-style format #608

Merged
merged 20 commits into from
Oct 24, 2023
Merged

Convert all docstrings to numpy-style format #608

merged 20 commits into from
Oct 24, 2023

Commits on Oct 20, 2023

  1. Start on generating numpy docstrings

    @jobovy
    jobovy committed Oct 20, 2023
    Configuration menu
    Copy the full SHA
    21fef51 View commit details
    Browse the repository at this point in the history

  2. More numpy docstrings for potential models

    @jobovy
    jobovy committed Oct 20, 2023
    Configuration menu
    Copy the full SHA
    fba7507 View commit details
    Browse the repository at this point in the history

  3. Add :orphan: directive to avoid sphinx warning

    @jobovy
    jobovy committed Oct 20, 2023
    Configuration menu
    Copy the full SHA
    fa6d6e8 View commit details
    Browse the repository at this point in the history

  4. Replace all Orbit docstrings with numpy-docstring-style versions and … 

    …fix some docstrings
    @jobovy
    jobovy committed Oct 20, 2023
    Configuration menu
    Copy the full SHA
    86f1757 View commit details
    Browse the repository at this point in the history

  5. numpy-style docstrings for Potential methods

    @jobovy
    jobovy committed Oct 20, 2023
    Configuration menu
    Copy the full SHA
    a78bd48 View commit details
    Browse the repository at this point in the history

  6. Numpy docstrings for new bruteSOS Orbit functions

    @jobovy
    jobovy committed Oct 20, 2023
    Configuration menu
    Copy the full SHA
    d89e319 View commit details
    Browse the repository at this point in the history

  7. numpy-style docstrings for Potential functions

    @jobovy
    jobovy committed Oct 20, 2023
    Configuration menu
    Copy the full SHA
    c2aa542 View commit details
    Browse the repository at this point in the history

  8. Fix surface density code (erroneously removed before...)

    @jobovy
    jobovy committed Oct 20, 2023
    Configuration menu
    Copy the full SHA
    af34dd2 View commit details
    Browse the repository at this point in the history

  9. numpy-style docstrings for remaining potential methods and functions … 

    …(planar and linear, forces, ...)
    @jobovy
    jobovy committed Oct 20, 2023
    Configuration menu
    Copy the full SHA
    6fb7fd4 View commit details
    Browse the repository at this point in the history

  10. numpy-style docstrings for potential classes

    @jobovy
    jobovy committed Oct 20, 2023
    Configuration menu
    Copy the full SHA
    61e3462 View commit details
    Browse the repository at this point in the history

  11. Numpy-style docstrings for actionAngle functions and methods

    @jobovy
    jobovy committed Oct 20, 2023
    Configuration menu
    Copy the full SHA
    190f874 View commit details
    Browse the repository at this point in the history

  12. Numpy-style docstrings for DF functions and methods

    @jobovy
    jobovy committed Oct 20, 2023
    Configuration menu
    Copy the full SHA
    c8125be View commit details
    Browse the repository at this point in the history

  13. Numpy-style docstrings for the util module

    @jobovy
    jobovy committed Oct 20, 2023
    Configuration menu
    Copy the full SHA
    0a33030 View commit details
    Browse the repository at this point in the history

  14. numpy-style docstrings for more Orbit functions

    @jobovy
    jobovy committed Oct 20, 2023
    Configuration menu
    Copy the full SHA
    e890271 View commit details
    Browse the repository at this point in the history

  15. numpy-style docstrings for the snapshot module

    @jobovy
    jobovy committed Oct 20, 2023
    Configuration menu
    Copy the full SHA
    b041386 View commit details
    Browse the repository at this point in the history

  16. Add numpy-style docstrings to HISTORY

    @jobovy
    jobovy committed Oct 20, 2023
    Configuration menu
    Copy the full SHA
    5dfb780 View commit details
    Browse the repository at this point in the history

  17. Small fixes to a bunch of errors in the numpy-style docstring conversion

    @jobovy
    jobovy committed Oct 20, 2023
    Configuration menu
    Copy the full SHA
    0cddf87 View commit details
    Browse the repository at this point in the history

  18. array_like --> numpy.ndarray

    @jobovy
    jobovy committed Oct 20, 2023
    Configuration menu
    Copy the full SHA
    9aa72f2 View commit details
    Browse the repository at this point in the history

  19. Fix weird quituplication of a function

    @jobovy
    jobovy committed Oct 20, 2023
    Configuration menu
    Copy the full SHA
    4513170 View commit details
    Browse the repository at this point in the history

Commits on Oct 24, 2023

  1. Hopefully final tweaks to numpy-style docstrings

    @jobovy
    jobovy committed Oct 24, 2023
    Configuration menu
    Copy the full SHA
    44e0980 View commit details
    Browse the repository at this point in the history