Skip to content

Commit

Permalink
Add more prominent callout about slots to API docs
Browse files Browse the repository at this point in the history
Fixes #971
  • Loading branch information
hynek committed Jul 28, 2022
1 parent 4f6b894 commit a67c84f
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions src/attr/_next_gen.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,17 @@ def define(
Differences to the classic `attr.s` that it uses underneath:
- Automatically detect whether or not *auto_attribs* should be `True`
(c.f. *auto_attribs* parameter).
- Automatically detect whether or not *auto_attribs* should be `True` (c.f.
*auto_attribs* parameter).
- If *frozen* is `False`, run converters and validators when setting an
attribute by default.
- *slots=True* (see :term:`slotted classes` for potentially surprising
behaviors)
- *slots=True*
.. caution::
Usually this has only upsides and few visible effects in everyday
programming. But it *can* lead to some suprising behaviors, so please
make sure to read :term:`slotted classes`.
- *auto_exc=True*
- *auto_detect=True*
- *order=False*
Expand Down

0 comments on commit a67c84f

Please sign in to comment.