gh-89682: [doc] reword docstring of __contains__ to clarify that it returns a bool #29043
Conversation
…s I was confused by help(list.__contains__)
|
Hello, and thanks for your contribution! I'm a bot set up to make sure that the project can legally accept this contribution by verifying everyone involved has signed the PSF contributor agreement (CLA). CLA MissingOur records indicate the following people have not signed the CLA: For legal reasons we need all the people listed to sign the CLA before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue. If you have recently signed the CLA, please wait at least one business day You can check yourself to see if the CLA has been received. Thanks again for the contribution, we look forward to reviewing it! |
|
|
|
This PR is stale because it has been open for 30 days with no activity. |
|
We'll need a news file for this. It's minor, but it touches a builtin. |
this suggested by iritkatriel Co-authored-by: Irit Katriel <[email protected]>
|
Most changes to Python require a NEWS entry. Please add it using the blurb_it web app or the blurb command-line tool. |
|
Most changes to Python require a NEWS entry. Please add it using the blurb_it web app or the blurb command-line tool. |
Misc/NEWS.d/next/Documentation/2022-11-26-21-43-05.gh-issue-89682.DhKoTM.rst
Outdated
Show resolved
Hide resolved
|
Thanks, I'll merge once CI completes. |
I was looking to implement a "custom object" to represent intervals of numbers
e.g.
if x in interval(2,4)will beTrue if (x >= 2) and (x < 4).I looked up
help(list.__contains__)and it says "Return key in self" which I interpreted as returning the actual key, not a boolean. A moment of confusion ensured and I tested[2,3].__contains__(2)to check that return value of__contains__is indeed boolean.The docstring change suggestion makes the return type of
__contains__clearer.A type hint for old school people who
?methods in jupyter notebooks ;)