Skip to content

Commit 3fdea7d

Browse files
committed
Edit docstring
1 parent 4da55b9 commit 3fdea7d

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

pyiron_snippets/factory.py

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -237,13 +237,15 @@ class _FactoryMade(ABC):
237237
"""
238238
A mix-in to make class-factory-produced classes pickleable.
239239
240-
If the factory is used as a decorator for another function, it will conflict with
241-
this function (i.e. the owned function will be the true function, and will mismatch
242-
with imports from that location, which will return the post-decorator factory made
243-
class). This can be resolved by setting the :attr:`_reduce_imports_as` attribute
244-
to a tuple of the (module, qualname) obtained from the decorated definition (or,
245-
-- DEPRECATED -- set :attr:`_class_returns_from_decorated_function` attribute to be
246-
the decorated function in the decorator definition.)
240+
If the factory is used as a decorator for another function (or class), it will
241+
conflict with this function (i.e. the owned function will be the true function,
242+
and will mismatch with imports from that location, which will return the
243+
post-decorator factory made class). This can be resolved by setting the
244+
:attr:`_reduce_imports_as` attribute to a tuple of the (module, qualname) obtained
245+
from the decorated definition in order to manually specify where it should be
246+
re-imported from. (DEPRECATED alternative: set
247+
:attr:`_class_returns_from_decorated_function` attribute to be the decorated
248+
function in the decorator definition.)
247249
"""
248250

249251
# DEPRECATED: Use _reduce_imports_as instead

0 commit comments

Comments
 (0)