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

Docstring patches #983

Merged
merged 12 commits into from
Jul 2, 2024
Merged

Docstring patches #983

merged 12 commits into from
Jul 2, 2024

Commits on Jun 26, 2024

  1. Fix links

    @abhro
    abhro committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    5c41370 View commit details
    Browse the repository at this point in the history

  2. Fix/add headers in method docstrings

    @abhro
    abhro committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    d12c399 View commit details
    Browse the repository at this point in the history

  3. Fix/add admonition blocks in docstrings

    @abhro
    abhro committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    2a023f1 View commit details
    Browse the repository at this point in the history

  4. Fix typo and remove redundant parens

    @abhro
    abhro committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    a135165 View commit details
    Browse the repository at this point in the history

  5. Fix fenced code examples

    @abhro
    abhro committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    40f6dd8 View commit details
    Browse the repository at this point in the history

  6. Update array print look

    @abhro
    abhro committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    c2c6ce8 View commit details
    Browse the repository at this point in the history

  7. Use latex builtin exp

    @abhro
    abhro committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    6b91946 View commit details
    Browse the repository at this point in the history

  8. Fix argument list 

    Extra newline causes markdown to interpret them as two different lists.
Remove newline to keep it all as one list.
    @abhro
    abhro committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    d3d9383 View commit details
    Browse the repository at this point in the history

  9. Split method docstrings

    @abhro
    abhro committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    170e975 View commit details
    Browse the repository at this point in the history

  10. Use proper ordered lists in docstrings 

    Lists were already formatted as bullet lists with
extraneous numbering or as manual plaintext lists.
    @abhro
    abhro committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    4eaa1e4 View commit details
    Browse the repository at this point in the history

Commits on Jun 27, 2024

  1. Add argument name in docstring description 

    Co-authored-by: Anthony Blaom, PhD <[email protected]>
    @abhro @ablaom
    abhro and ablaom authored Jun 27, 2024
    Configuration menu
    Copy the full SHA
    a9442fa View commit details
    Browse the repository at this point in the history

Commits on Jun 28, 2024

  1. Match variable names to docs 

    Update variable name style (and comments) to match docs
    @abhro
    abhro committed Jun 28, 2024
    Configuration menu
    Copy the full SHA
    08a014e View commit details
    Browse the repository at this point in the history