luxolus
/
pyo3
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: note `__richcmp__` disables default `__hash__`

This commit is contained in:
David Hewitt 2022-08-21 16:29:22 +01:00
parent f7ebda8ce3
commit c5ecf47890
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
guide/src/class/protocols.md
View File

@ -67,6 +67,8 @@ given signatures should be interpreted as follows:
Overloads Python comparison operations (`==`, `!=`, `<`, `<=`, `>`, and `>=`).
The `CompareOp` argument indicates the comparison operation being performed.
_Note that implementing `__richcmp__` will cause Python not to generate a default `__hash__` implementation, so consider implementing `__hash__` when implementing `__richcmp__`._
<details>
<summary>Return type</summary>
The return type will normally be `PyResult<bool>`, but any Python object can be returned.