Merge pull request #132 from machow/doc-class-docstring

docs: how to document classes

Author: machow

docs/get-started/docstring-examples.qmd

@@ -132,3 +132,39 @@ def f():
 :::{.callout-note}
 Linking to functions documented outside your package must be configured in the [interlinks filter](./interlinks.qmd).
 :::
+
+
+## How do I document a class?
+
+See [this numpydoc page on documenting classes](https://numpydoc.readthedocs.io/en/latest/format.html#documenting-classes).
+
+Below is a simple example of a class docstring.
+
+```python
+class MyClass:
+    """A great class.
+
+    Parameters
+    ----------
+    a:
+        Some parameter.
+
+    Attributes
+    ----------
+    x:
+        An integer
+    """
+
+
+    x: int = 1
+
+
+    def __init__(self, a: str):
+        self.a = a
+```
+
+Note these two important pieces:
+
+* Document your `__init__` method parameters on the class docstring.
+* You can use an `Attributes` section in your docstring.
+