summaryrefslogtreecommitdiff
path: root/numpy/compat/py3k.py
diff options
context:
space:
mode:
Diffstat (limited to 'numpy/compat/py3k.py')
-rw-r--r--numpy/compat/py3k.py3
1 files changed, 3 insertions, 0 deletions
diff --git a/numpy/compat/py3k.py b/numpy/compat/py3k.py
index f36aaca17..e1e236d92 100644
--- a/numpy/compat/py3k.py
+++ b/numpy/compat/py3k.py
@@ -94,6 +94,9 @@ class contextlib_nullcontext:
cm = optional_cm if condition else nullcontext()
with cm:
# Perform operation, using optional_cm if condition is True
+
+ .. note::
+ Prefer using `contextlib.nullcontext` instead of this context manager.
"""
def __init__(self, enter_result=None):