Skip to content

Commit 0eab8e1

Browse files
IgnacioHerediaalvarolopez
authored andcommitted
Add functools.wraps warning to docs
1 parent d67e1a2 commit 0eab8e1

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

doc/source/user/v2-api.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -285,3 +285,10 @@ want to do so, you may find useful to inhering from the
285285

286286
.. autoclass:: deepaas.model.v2.base.BaseModel
287287
:members:
288+
289+
.. warning::
290+
The API uses ``multiprocessing`` for handling tasks. Therefore if you use
291+
decorators around your methods, please follow best practices and use
292+
`functools.wraps <http://gael-varoquaux.info/programming/decoration-in-python-done-right-decorating-and-pickling.html>`_
293+
so that the methods are still pickable. Beware also of using global variables
294+
that might not be shared between processes.

0 commit comments

Comments
 (0)