Skip to content
Snippets Groups Projects
Commit e837fc03 authored by Martin Reinecke's avatar Martin Reinecke
Browse files

improve docstrings

parent a0fa21d9
Branches
Tags
1 merge request!436improve docstrings
Pipeline #71907 passed
...@@ -146,6 +146,11 @@ def push_sseq(sseq): ...@@ -146,6 +146,11 @@ def push_sseq(sseq):
---------- ----------
sseq: SeedSequence sseq: SeedSequence
the SeedSequence object to be used from this point the SeedSequence object to be used from this point
Notes
-----
Make sure that every call to `push_sseq` has a matching call to
`pop_sseq`, otherwise the module's internal stack will grow indefinitely!
""" """
_sseq.append(sseq) _sseq.append(sseq)
_rng.append(np.random.default_rng(_sseq[-1])) _rng.append(np.random.default_rng(_sseq[-1]))
...@@ -161,6 +166,11 @@ def push_sseq_from_seed(seed): ...@@ -161,6 +166,11 @@ def push_sseq_from_seed(seed):
---------- ----------
seed: int seed: int
the seed from which the new SeedSequence will be built the seed from which the new SeedSequence will be built
Notes
-----
Make sure that every call to `push_sseq_from_seed` has a matching call to
`pop_sseq`, otherwise the module's internal stack will grow indefinitely!
""" """
_sseq.append(np.random.SeedSequence(seed)) _sseq.append(np.random.SeedSequence(seed))
_rng.append(np.random.default_rng(_sseq[-1])) _rng.append(np.random.default_rng(_sseq[-1]))
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment