-
Notifications
You must be signed in to change notification settings - Fork 132
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
Add Sybil examples to most classes in the root hoomd namespace. #1628
Merged
Conversation
This file contains 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
Decided that no Sybil examples are needed here beyond those already provided.
Also make examples more consistent across the base hoomd namespace.
joaander
added
the
validate
Execute long running validation tests on pull requests
label
Sep 26, 2023
joaander
requested review from
a team,
b-butler and
vyasr
and removed request for
a team
September 26, 2023 15:38
b-butler
reviewed
Oct 3, 2023
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.
This was/is a lot of work! Overall looks great and should be helpful to users.
Co-authored-by: Brandon Butler <[email protected]>
b-butler
approved these changes
Oct 9, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Add Sybil examples and revise documentation for all classes in the
hoomd
namespace (excludinghoomd.md
andhoomd.hpmc
which will be added in a future pull request).Motivation and context
Many users prefer to copy and paste these minimal examples. Sybil tests the examples to ensure they operate.
How has this been tested?
I rendered the documentation locally. Pull request reviewers can click the "Details" link next to readthedocs.io in the checks below to see the new documentation.
Change log
Checklist:
sphinx-doc/credits.rst
) in the pull request source branch.