Add sybil examples to more files #1586
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
Allow pytest to succeed in environments where sybil is not available.
* Exclude those that we have not yet updated to work with sybil. * Change R""" to r""" to avoid sybil parsing errors.
joaander
requested review from
a team,
b-butler and
SchoeniPhlippsn
and removed request for
a team
b-butler
reviewed
Jul 18, 2023
The example simulation had 0 particles on rank 0, leading to (0,) shape arrays instead of the expected (0,3) shape array.
joaander
added
the
validate
Co-authored-by: Brandon Butler <[email protected]>
| @@ -681,13 +655,13 @@ def categories(self): | |||
|
|
|||
| @property | |||
| def string_categories(self): | |||
| """`list` of `str`: A list of the string names of the allowed \ | |||
| """list[str]: A list of the string names of the allowed \ | |||
There was a problem hiding this comment.
Suggested change
| """list[str]: A list of the string names of the allowed \ | |
| """`list` [`str`]: A list of the string names of the allowed \ |
There was a problem hiding this comment.
These are parsed correctly as is. The napoleon engine in sphinx understands these type annotations and expands list and str to links. We need explicit links only in cases where we add additional text to the type e.g. "list [str], optional".
| @@ -348,32 +363,74 @@ def set_snapshot(self, snapshot): | |||
|
|
|||
| @property | |||
| def particle_types(self): | |||
| """list[str]: List of all particle types in the simulation state.""" | |||
| """list[str]: List of all particle types in the simulation state. | |||
There was a problem hiding this comment.
Suggested change
| """list[str]: List of all particle types in the simulation state. | |
| """`list` [`str`]: List of all particle types in the simulation state. |
Same for all the following
SchoeniPhlippsn
approved these changes
Jul 20, 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 to all *.py files in the
hoomdsource directory. Also reword some documentation for clarity and reduce the toctree depth.Motivation and context
Provide users with code examples that are tested and known to execute without errors.
How has this been tested?
I executed sybil tests locally (serial CPU build).
Change log
No additional change log is needed over that in #1574.
Checklist:
sphinx-doc/credits.rst) in the pull request source branch.