Updating Examples in Documentation #2185
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Updated the example in integrate.py to comply with the current hoomd syntax and converted examples in hoomd/md so that they are tested with Sybil
Motivation and context
The old example in integrate.py was from an older version of hoomd and the syntax was not functional in the current version of hoomd
Partially Resolves #1958
I am not sure if this catches all of the old examples
How has this been tested?
The example in integrate.py was tested by following the tutorials in a jupyter notebook.
The sphinx documentation was rebuilt.
Checklist:
[ x] I have reviewed the Contributor Guidelines.
[x ] I agree with the terms of the HOOMD-blue Contributor Agreement.
My name is on the list of contributors (
sphinx-doc/credits.rst) in the pull request source branch.I have summarized these changes in
CHANGELOG.rstfollowing the established format.