gh-89682: [doc] reword docstring of __contains__ to clarify that it returns a bool (GH-29043)

This commit is contained in:
Ivan Savov 2022-11-26 17:24:04 -05:00 committed by GitHub
parent 7f005749b2
commit 25bc115df9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 2 additions and 1 deletions

View File

@ -0,0 +1 @@
Reworded docstring of the default ``__contains__`` to clarify that it returns a :class:`bool`.

View File

@ -8741,7 +8741,7 @@ static pytype_slotdef slotdefs[] = {
SQSLOT(__delitem__, sq_ass_item, slot_sq_ass_item, wrap_sq_delitem,
"__delitem__($self, key, /)\n--\n\nDelete self[key]."),
SQSLOT(__contains__, sq_contains, slot_sq_contains, wrap_objobjproc,
"__contains__($self, key, /)\n--\n\nReturn key in self."),
"__contains__($self, key, /)\n--\n\nReturn bool(key in self)."),
SQSLOT(__iadd__, sq_inplace_concat, NULL,
wrap_binaryfunc,
"__iadd__($self, value, /)\n--\n\nImplement self+=value."),