Skip to content

Commit 0e8e82a

Browse files
authored
Remove mention of cmp= from next gen docs (#1355)
`attrs.define` and `attrs.field` do not actually accept `cmp=` anymore, but the docs still discuss them
1 parent a59c5d7 commit 0e8e82a

File tree

1 file changed

+1
-11
lines changed

1 file changed

+1
-11
lines changed

src/attr/_next_gen.py

+1-11
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ def define(
7676
sensible ``__ne__`` by default, so it *should* be enough to only
7777
implement ``__eq__`` in most cases).
7878
79-
Passing True or False` to *init*, *repr*, *eq*, *cmp*, or *hash*
79+
Passing True or False` to *init*, *repr*, *eq*, or *hash*
8080
overrides whatever *auto_detect* would determine.
8181
8282
auto_exc (bool):
@@ -151,10 +151,6 @@ def define(
151151
152152
.. seealso:: `comparison`
153153
154-
cmp (bool | None):
155-
Setting *cmp* is equivalent to setting *eq* and *order* to the same
156-
value. Must not be mixed with *eq* or *order*.
157-
158154
unsafe_hash (bool | None):
159155
If None (default), the ``__hash__`` method is generated according
160156
how *eq* and *frozen* are set.
@@ -504,12 +500,6 @@ def field(
504500
505501
.. seealso:: `comparison`
506502
507-
cmp(bool | ~typing.Callable):
508-
Setting *cmp* is equivalent to setting *eq* and *order* to the same
509-
value. Must not be mixed with *eq* or *order*.
510-
511-
.. seealso:: `comparison`
512-
513503
hash (bool | None):
514504
Include this attribute in the generated ``__hash__`` method. If
515505
None (default), mirror *eq*'s value. This is the correct behavior

0 commit comments

Comments
 (0)