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

Add Sybil examples to most classes in the root hoomd namespace. #1628

Merged
merged 22 commits into from Oct 10, 2023

Conversation

joaander
Copy link
Member

Description

Add Sybil examples and revise documentation for all classes in the hoomd namespace (excluding hoomd.md and hoomd.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

Changed:

* Revise class documentation.
* Add more code snippets to the class documentation.

Checklist:

@joaander joaander added the validate Execute long running validation tests on pull requests label Sep 26, 2023
@joaander joaander marked this pull request as ready for review September 26, 2023 15:38
@joaander joaander requested review from a team as code owners September 26, 2023 15:38
@joaander joaander requested review from b-butler and vyasr and removed request for a team September 26, 2023 15:38
Copy link
Member

@b-butler b-butler left a 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.

sphinx-doc/module-hoomd-write.rst Show resolved Hide resolved
hoomd/data/typeparam.py Outdated Show resolved Hide resolved
hoomd/data/typeparam.py Show resolved Hide resolved
hoomd/data/typeparam.py Show resolved Hide resolved
joaander and others added 2 commits October 4, 2023 14:10
Co-authored-by: Brandon Butler <butlerbr@umich.edu>
@joaander joaander requested a review from b-butler October 5, 2023 14:56
@joaander joaander merged commit da748d0 into trunk-minor Oct 10, 2023
40 checks passed
@joaander joaander deleted the yet-more-sybil branch October 10, 2023 18:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
validate Execute long running validation tests on pull requests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants