Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

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.

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

Already on GitHub?Sign in to your account

Merged

Conversation

@ivanistheone
Copy link
Contributor

@ivanistheoneivanistheone commentedOct 18, 2021
edited by bedevere-bot
Loading

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 uphelp(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 ;)

@the-knights-who-say-ni

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 thePSF contributor agreement (CLA).

CLA Missing

Our records indicate the following people have not signed the CLA:

@ivanistheone

For legal reasons we need all the people listed to sign the CLA before we can look at your contribution. Please followthe steps outlined in the CPython devguide to rectify this issue.

If you have recently signed the CLA, please wait at least one business day
before our records are updated.

You cancheck yourself to see if the CLA has been received.

Thanks again for the contribution, we look forward to reviewing it!

@ivanistheone
Copy link
ContributorAuthor

ivanistheone commentedOct 18, 2021
edited
Loading

git diff --color-words for this PR

Screen Shot 2021-10-18 at 6 56 44 PM

  • red = words removed
  • blue = words added

@github-actions
Copy link

This PR is stale because it has been open for 30 days with no activity.

@github-actionsgithub-actionsbot added the staleStale PR or inactive for long period of time. labelNov 18, 2021
Copy link
Contributor

@MaxwellDupreMaxwellDupre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Looks ok.

@iritkatrieliritkatriel changed the titledoc: issue45519 Minor clarification in doc string for __contains__ builtin methodgh-89682: [doc]Minor clarification in doc string for __contains__ builtin methodNov 26, 2022
@iritkatrieliritkatriel changed the titlegh-89682: [doc]Minor clarification in doc string for __contains__ builtin methodgh-89682: [doc] reword docstring of __contains__ method to clarify that it returns a boolNov 26, 2022
@iritkatrieliritkatriel removed the staleStale PR or inactive for long period of time. labelNov 26, 2022
@iritkatriel
Copy link
Member

We'll need a news file for this. It's minor, but it touches a builtin.

@iritkatrieliritkatriel changed the titlegh-89682: [doc] reword docstring of __contains__ method to clarify that it returns a boolgh-89682: [doc] reword docstring of __contains__ to clarify that it returns a boolNov 26, 2022
this suggested by iritkatrielCo-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
@bedevere-bot
Copy link

Most changes to Pythonrequire a NEWS entry.

Please add it using theblurb_it web app or theblurb command-line tool.

@bedevere-bot
Copy link

Most changes to Pythonrequire a NEWS entry.

Please add it using theblurb_it web app or theblurb command-line tool.

@iritkatrieliritkatriel self-assigned thisNov 26, 2022
@iritkatriel
Copy link
Member

Thanks, I'll merge once CI completes.

ivanistheone reacted with hooray emoji

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

@iritkatrieliritkatrieliritkatriel left review comments

@markshannonmarkshannonAwaiting requested review from markshannonmarkshannon is a code owner

+1 more reviewer

@MaxwellDupreMaxwellDupreMaxwellDupre approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@iritkatrieliritkatriel

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@ivanistheone@the-knights-who-say-ni@iritkatriel@bedevere-bot@MaxwellDupre@ezio-melotti

[8]ページ先頭

©2009-2025 Movatter.jp