Skip to content

Commit 4a0d0df

Browse files
authored
Merge pull request #396 from bashtage/user-bit-gen-warning
DOC: Add warning to UBG
2 parents 7f2acc4 + f8a4c40 commit 4a0d0df

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

randomgen/wrapper.pyx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,16 @@ cdef class UserBitGenerator(BitGenerator):
7272
a single input. If not provided, getting the ``state`` property
7373
will raise NotImplementedError.
7474
75+
Notes
76+
-----
77+
There is one key caveat when using a UserBitGenerator. The callable must run without
78+
exceptions.
79+
80+
.. warning::
81+
It is essential that the callable function runs without producing an Exception.
82+
Exceptions will be silently ignored and the generator will produce incorrect
83+
results.
84+
7585
Examples
7686
--------
7787
A generator that rotates across 4 values from random.org.

0 commit comments

Comments
 (0)