diff options
author | Stephan Hoyer <shoyer@google.com> | 2018-11-11 13:35:58 -0800 |
---|---|---|
committer | Stephan Hoyer <shoyer@google.com> | 2018-11-11 13:35:58 -0800 |
commit | 9fa3a4e9802b32c985f6a1fc14dd315a2656ac38 (patch) | |
tree | d6036870ba4e46fc7ae645fd305809838644b62e /numpy/core/overrides.py | |
parent | aa72452b54835ea1c5354d2203cb9d7b1c9b9206 (diff) | |
download | numpy-9fa3a4e9802b32c985f6a1fc14dd315a2656ac38.tar.gz |
DOC: add docstring for override_module
Diffstat (limited to 'numpy/core/overrides.py')
-rw-r--r-- | numpy/core/overrides.py | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/numpy/core/overrides.py b/numpy/core/overrides.py index 1dab8f338..e4d505f06 100644 --- a/numpy/core/overrides.py +++ b/numpy/core/overrides.py @@ -151,7 +151,16 @@ def verify_matching_signatures(implementation, dispatcher): def override_module(module): - """Decorator for overriding __module__ on a function or class.""" + """Decorator for overriding __module__ on a function or class. + + Example usage:: + + @override_module('numpy') + def example(): + pass + + assert example.__module__ == 'numpy' + """ def decorator(func): if module is not None: func.__module__ = module |