From e837fc03ca378b65d0bd2498caddf18ad5be04c7 Mon Sep 17 00:00:00 2001
From: Martin Reinecke <martin@mpa-garching.mpg.de>
Date: Wed, 1 Apr 2020 12:05:38 +0200
Subject: [PATCH] improve docstrings
---
nifty6/random.py | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/nifty6/random.py b/nifty6/random.py
index 93b73b36f..a5ee9a4ed 100644
--- a/nifty6/random.py
+++ b/nifty6/random.py
@@ -146,6 +146,11 @@ def push_sseq(sseq):
----------
sseq: SeedSequence
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)
_rng.append(np.random.default_rng(_sseq[-1]))
@@ -161,6 +166,11 @@ def push_sseq_from_seed(seed):
----------
seed: int
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))
_rng.append(np.random.default_rng(_sseq[-1]))
--
GitLab