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

Correct wrong units in docstring in multiple locations #123

Merged
merged 2 commits into from
Feb 6, 2024

Conversation

cr-xu
Copy link
Member

@cr-xu cr-xu commented Feb 5, 2024

Description

Improve the docstring, make sure the units for the phase space dimensions are correct now.

Motivation and Context

  • I have raised an issue to propose this change (required for new features and bug fixes)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (update in the documentation)

Checklist

  • I have updated the changelog accordingly (required).
  • My change requires a change to the documentation.
  • I have updated the tests accordingly (required for a bug fix or a new feature).
  • I have updated the documentation accordingly.
  • I have reformatted the code and checked that formatting passes (required).
  • I have have fixed all issues found by flake8 (required).
  • I have ensured that all pytest tests pass (required).
  • I have run pytest on a machine with a CUDA GPU and made sure all tests pass (required).
  • I have checked that the documentation builds (required).

Note: We are using a maximum length of 88 characters per line

@cr-xu cr-xu linked an issue Feb 5, 2024 that may be closed by this pull request
@cr-xu cr-xu requested a review from jank324 February 5, 2024 21:35
@jank324 jank324 merged commit 2e16423 into master Feb 6, 2024
9 checks passed
@jank324 jank324 deleted the 122-wrong-units-in-docstring-in-multiple-locations branch February 6, 2024 10:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Wrong units in Docstring in multiple locations
2 participants