We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 417e479 commit 482b618Copy full SHA for 482b618
docs/get-started/docstring-examples.qmd
@@ -132,3 +132,13 @@ def f():
132
:::{.callout-note}
133
Linking to functions documented outside your package must be configured in the [interlinks filter](./interlinks.qmd).
134
:::
135
+
136
137
+## How do I document a class?
138
139
+See [this numpydoc page on documenting classes](https://numpydoc.readthedocs.io/en/latest/format.html#documenting-classes).
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.
0 commit comments