Skip to content

Commit a67c84f

Browse files
committed
Add more prominent callout about slots to API docs
Fixes #971
1 parent 4f6b894 commit a67c84f

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

src/attr/_next_gen.py

+9-4
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,17 @@ def define(
4949
5050
Differences to the classic `attr.s` that it uses underneath:
5151
52-
- Automatically detect whether or not *auto_attribs* should be `True`
53-
(c.f. *auto_attribs* parameter).
52+
- Automatically detect whether or not *auto_attribs* should be `True` (c.f.
53+
*auto_attribs* parameter).
5454
- If *frozen* is `False`, run converters and validators when setting an
5555
attribute by default.
56-
- *slots=True* (see :term:`slotted classes` for potentially surprising
57-
behaviors)
56+
- *slots=True*
57+
58+
.. caution::
59+
60+
Usually this has only upsides and few visible effects in everyday
61+
programming. But it *can* lead to some suprising behaviors, so please
62+
make sure to read :term:`slotted classes`.
5863
- *auto_exc=True*
5964
- *auto_detect=True*
6065
- *order=False*

0 commit comments

Comments
 (0)