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
Remove features deprecated in v3.x. #1496
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just have one small change and one thought to consider.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The examples in the docstring for the constrain.Rigid
class still use the charges
and diameter
keys in the body property.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One last small thing before merging.
hoomd/md/constrain.py
Outdated
particle position and orientations in body coordinates (see `body`). Then, | ||
`Rigid` takes control of the constituent particles and sets their position | ||
and orientation in the simulation box relative to the position and | ||
particles. For each rigid body particle type, you set the constituent |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
particles. For each rigid body particle type, you set the constituent | |
particles. For each rigid body particle type, set the constituent |
Try to stay away from using the word "you" in documentation if possible.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK, I did so in Rigid
. Fixing the rest of the documentation is far beyond the scope intended for this pull request.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Description
Remove features deprecated in v3.x.
Motivation and context
Follow through on our promise to remove these non-functional or not needed features.
How has this been tested?
I updated the CI tests and checked that the removed features are not present in the documentation.
Change log
Checklist:
sphinx-doc/credits.rst
) in the pull request source branch.