Skip to content

Document docstrings for classes created with make_class #1623

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
user01010111 wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −0
Open

Document docstrings for classes created with make_class #1623

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -745,6 +745,17 @@ True
<class 'int'>
```

To give the generated class a docstring, pass `__doc__` in the `class_body` argument:

```{doctest}
>>> C = make_class("C", ["x", "y"], class_body={"__doc__": "A pair of values."})
>>> C.__doc__
'A pair of values.'
```

You can also assign to `C.__doc__` after creating the class.
Both approaches make the docstring available to `help(C)`.

You can still have power over the attributes if you pass a dictionary of name: {func}`~attrs.field` mappings and can pass the same arguments as you can to `@attrs.define`:

```{doctest}
Expand Down