Skip to content

Commit 482b618

Browse files
committed
docs: how to document classes
1 parent 417e479 commit 482b618

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/get-started/docstring-examples.qmd

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,3 +132,13 @@ def f():
132132
:::{.callout-note}
133133
Linking to functions documented outside your package must be configured in the [interlinks filter](./interlinks.qmd).
134134
:::
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

Comments
 (0)