File tree Expand file tree Collapse file tree 1 file changed +7
-4
lines changed Expand file tree Collapse file tree 1 file changed +7
-4
lines changed Original file line number Diff line number Diff line change @@ -138,10 +138,7 @@ Linking to functions documented outside your package must be configured in the [
138
138
139
139
See [ this numpydoc page on documenting classes] ( https://numpydoc.readthedocs.io/en/latest/format.html#documenting-classes ) .
140
140
141
- Be sure to note these two important pieces:
142
-
143
- * Document your ` __init__ ` method parameters on the class docstring.
144
- * You can use an ` Attributes ` section in your docstring.
141
+ Below is a simple example of a class docstring.
145
142
146
143
``` python
147
144
class MyClass :
@@ -165,3 +162,9 @@ class MyClass:
165
162
def __init__ (self , a : str ):
166
163
self .a = a
167
164
```
165
+
166
+ Note these two important pieces:
167
+
168
+ * Document your ` __init__ ` method parameters on the class docstring.
169
+ * You can use an ` Attributes ` section in your docstring.
170
+
You can’t perform that action at this time.
0 commit comments