blob: d303e9e182e785b1eaa2307ba3cccde5c759fab3 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
|
"""Numpydoc test module.
.. currentmodule:: numpydoc_test_module
.. autosummary::
:toctree: generated/
MyClass
my_function
Reference [1]_
References
----------
.. [1] https://numpydoc.readthedocs.io
"""
__all__ = ["MyClass", "my_function"]
class MyClass:
"""A class.
Reference [2]_
Parameters
----------
*args : iterable
Arguments.
**kwargs : dict
Keyword arguments.
References
----------
.. [2] https://numpydoc.readthedocs.io
"""
def example(self, x):
"""Example method."""
pass
def my_function(*args, **kwargs):
"""Return None.
See [3]_.
Parameters
----------
*args : iterable
Arguments.
**kwargs : dict
Keyword arguments.
Returns
-------
out : None
The output.
References
----------
.. [3] https://numpydoc.readthedocs.io
"""
return None
|
