Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Nov 26, 2022
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5cb5c4a
Minor clarification in doc string for __contains__ builtin method, bc…
ivanistheone Oct 18, 2021
2fb95c2
dict.__contains__ docstring improvement
ivanistheone Nov 26, 2022
3c0d977
Merge branch 'main' into typo_fix__contains__docstr
iritkatriel Nov 26, 2022
b51325a
📜🤖 Added by blurb_it.
blurb-it[bot] Nov 26, 2022
3ca3d98
formatting in news
iritkatriel Nov 26, 2022
47a13af
Merge branch 'main' into typo_fix__contains__docstr
iritkatriel Nov 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Documentation/2022-11-26-21-43-05.gh-issue-89682.DhKoTM.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Reworded docstring of the default ``__contains__`` to clarify that it returns a :class:`bool`.
2 changes: 1 addition & 1 deletion Objects/typeobject.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."),
Expand Down