Skip to content
Snippets Groups Projects
Commit ffde2c83 authored by Frederik Hennig's avatar Frederik Hennig
Browse files

fix doc comments

parent da6cb8a7
No related branches found
No related tags found
1 merge request!481Introduce immutable RNG state for correct comparisons and pickling
Pipeline #80327 passed
...@@ -14,7 +14,7 @@ from ..types import UserTypeSpec, create_type, PsIeeeFloatType, PsNamedArrayType ...@@ -14,7 +14,7 @@ from ..types import UserTypeSpec, create_type, PsIeeeFloatType, PsNamedArrayType
class RngState(ABC): class RngState(ABC):
"""State of an RNG object. """State of an RNG object.
Instances of `RngStateBase` must be immutable, hashable, and comparable Instances of `RngState` must be immutable, hashable, and comparable
to facilitate comparison, hashing, and pickle serialization of RNG invocation expressions. to facilitate comparison, hashing, and pickle serialization of RNG invocation expressions.
""" """
...@@ -107,7 +107,8 @@ class RngBase(ABC): ...@@ -107,7 +107,8 @@ class RngBase(ABC):
"""Get a symbolic invocation of the RNG and a symbol representing its result. """Get a symbolic invocation of the RNG and a symbol representing its result.
Args: Args:
counter: An expression specifying the external counter part of the RNG state, optional counter: An expression specifying the external counter part of the RNG state,
e.g. the time step counter
""" """
rng_func, state = self._get_rng_func() rng_func, state = self._get_rng_func()
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please to comment