Skip to content

Commit

Permalink
Link to correct classes and members.
Browse files Browse the repository at this point in the history
  • Loading branch information
joaander committed Nov 26, 2024
1 parent 5ae6b2d commit 1ba6c5c
Show file tree
Hide file tree
Showing 7 changed files with 12 additions and 10 deletions.
6 changes: 4 additions & 2 deletions hoomd/custom/custom_operation.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,17 @@ class CustomOperation(TriggeredOperation, metaclass=_AbstractLoggable):
----------
**Members inherited from**
`CustomOperation <hoomd.operation.TriggeredOperation>`:
`CustomOperation <hoomd.custom.CustomOperation>`:
.. py:method:: act
Perform the action of the custom action if attached
`Read more... <hoomd.custom.CustomOperation.act>`
.. py:property:: action
Action that this operation wraps.
`Read more... <hoomd.custom.CustomOperation.action>`
"""

_override_setattr = {'_action', "_export_dict", "_simulation"}
Expand Down Expand Up @@ -117,7 +119,7 @@ def act(self, timestep):

@property
def action(self):
""":hoomd.custom.Action: Action that this operation wraps."""
"""hoomd.custom.Action: Action that this operation wraps."""
return self._action

def __setstate__(self, state):
Expand Down
4 changes: 2 additions & 2 deletions hoomd/hpmc/integrate.py
Original file line number Diff line number Diff line change
Expand Up @@ -917,7 +917,7 @@ class ConvexSpheropolygon(HPMCIntegrator):
----------
**Members defined in** `Sphere`:
**Members defined in** `ConvexSpheropolygon`:
Attributes:
shape (`TypeParameter` [``particle type``, `dict`]):
Expand Down Expand Up @@ -1024,7 +1024,7 @@ class SimplePolygon(HPMCIntegrator):
----------
**Members defined in** `ConvexPolygon`:
**Members defined in** `SimplePolygon`:
Attributes:
shape (`TypeParameter` [``particle type``, `dict`]):
Expand Down
4 changes: 2 additions & 2 deletions hoomd/hpmc/shape_move.py
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ def __call__(self, type, param_list):
----------
**Members defined in** `Elastic`:
**Members defined in** `ShapeSpace`:
Attributes:
callback (``callable`` [`str`, `list`], `dict` ]): The python function
Expand Down Expand Up @@ -329,7 +329,7 @@ class Vertex(ShapeMove):
----------
**Members defined in** `Elastic`:
**Members defined in** `Vertex`:
Attributes:
vertex_move_probability (`float`): Average fraction of vertices to
Expand Down
2 changes: 1 addition & 1 deletion hoomd/md/mesh/bond.py
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ class Tether(MeshPotential):
----------
**Members defined in** `FENEWCA`:
**Members defined in** `Tether`:
Attributes:
params (TypeParameter[``mesh name``,dict]):
Expand Down
2 changes: 1 addition & 1 deletion hoomd/md/methods/methods.py
Original file line number Diff line number Diff line change
Expand Up @@ -775,7 +775,7 @@ class Langevin(Method):
----------
**Members defined in** `TriggeredOperation`:
**Members defined in** `Langevin`:
Attributes:
filter (hoomd.filter.filter_like): Subset of particles to
Expand Down
2 changes: 1 addition & 1 deletion hoomd/md/pair/pair.py
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ class Pair(force.Force):
.. py:attribute:: r_on
Radius at which the XPLOR smoothing function starts.
`Read more... <hoomd.md.pair.Pair.r_cut>`
`Read more... <hoomd.md.pair.Pair.r_on>`
.. py:method:: compute_energy
Expand Down
2 changes: 1 addition & 1 deletion hoomd/variant/scalar.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ def _max(self):
----------
**Members inherited from**
`BoxVariant <hoomd.variant.box.BoxVariant>`:
`Variant <hoomd.variant.Variant>`:
.. py:method:: __call__
Expand Down

0 comments on commit 1ba6c5c

Please sign in to comment.