Coverage for /home/martinb/.local/share/virtualenvs/camcops/lib/python3.6/site-packages/scipy/misc/doccer.py : 62%

Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1''' Utilities to allow inserting docstring fragments for common
2parameters into function and method docstrings'''
4import numpy as np
5from .._lib import doccer as _ld
7__all__ = ['docformat', 'inherit_docstring_from', 'indentcount_lines',
8 'filldoc', 'unindent_dict', 'unindent_string']
10@np.deprecate(message="scipy.misc.docformat is deprecated in Scipy 1.3.0")
11def docformat(docstring, docdict=None):
12 return _ld.docformat(docstring, docdict)
15@np.deprecate(message="scipy.misc.inherit_docstring_from is deprecated "
16 "in SciPy 1.3.0")
17def inherit_docstring_from(cls):
18 return _ld.inherit_docstring_from(cls)
21@np.deprecate(message="scipy.misc.extend_notes_in_docstring is deprecated "
22 "in SciPy 1.3.0")
23def extend_notes_in_docstring(cls, notes):
24 return _ld.extend_notes_in_docstring(cls, notes)
27@np.deprecate(message="scipy.misc.replace_notes_in_docstring is deprecated "
28 "in SciPy 1.3.0")
29def replace_notes_in_docstring(cls, notes):
30 return _ld.replace_notes_in_docstring(cls, notes)
33@np.deprecate(message="scipy.misc.indentcount_lines is deprecated "
34 "in SciPy 1.3.0")
35def indentcount_lines(lines):
36 return _ld.indentcount_lines(lines)
39@np.deprecate(message="scipy.misc.filldoc is deprecated in SciPy 1.3.0")
40def filldoc(docdict, unindent_params=True):
41 return _ld.filldoc(docdict, unindent_params)
44@np.deprecate(message="scipy.misc.unindent_dict is deprecated in SciPy 1.3.0")
45def unindent_dict(docdict):
46 return _ld.unindent_dict(docdict)
49@np.deprecate(message="scipy.misc.unindent_string is deprecated in SciPy 1.3.0")
50def unindent_string(docstring):
51 return _ld.unindent_string(docstring)