Document PicklingError for ensure_annotations in multiprocessing (#32)

kislyuk · Oct 7, 2019 · f1fb714 · f1fb714
1 parent 0970741
commit f1fb714
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/ensure/main.py b/ensure/main.py
@@ -878,6 +878,12 @@ def f(x: int, y: float) -> float:
 
         >>> ensure.EnsureError: Argument y of type <class 'int'> to
         <function f at 0x109b7c710> does not match annotation type <class 'float'>
+
+    .. warning::
+
+       The current implementation of the decorator might trigger
+       a ``_pickle.PicklingError`` when a decorated function is run through
+       ``multiprocessing``.
     """
 
     if f.__defaults__: