Skip to content

[2.7] bpo-33006 - Correct filter doc string to clarify 2nd argument can be iterable#6015

Merged
miss-islington merged 6 commits intopython:2.7from
TonyFlury:bpo-33006
May 29, 2019
Merged

[2.7] bpo-33006 - Correct filter doc string to clarify 2nd argument can be iterable#6015
miss-islington merged 6 commits intopython:2.7from
TonyFlury:bpo-33006

Conversation

@TonyFlury
Copy link
Contributor

@TonyFlury TonyFlury commented Mar 7, 2018 •

iteration, or an iterator. If iterable is a string or a tuple, the result\n\
also has that type; otherwise it is always a list. If function is None, the\n\
identity function is assumed, that is, all elements of iterable that are\n\
false are removed.");
Copy link
Member

Choose a reason for hiding this comment

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

While accurate, it seems a bit too verbose for a doc string. How about using the current Python 3 docstring as a starting point?

| Return an iterator yielding those items of iterable for which function(item)
| is true. If function is None, return the items that are true.

s/an iterator/a sequence/ and include the 'If iterable is a string or tuple ...' sentence?

@bedevere-bot
Copy link

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@TonyFlury
Copy link
Contributor Author

I have made the requested changes; please review again.

@bedevere-bot
Copy link

Thanks for making the requested changes!

@ned-deily: please review the changes made to this pull request.

@csabella csabella requested a review from ned-deily May 29, 2019 00:22
Copy link
Member

@ned-deily ned-deily left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for making the changes @TonyFlury. And thanks for the reminder @csabella!

@ned-deily ned-deily closed this May 29, 2019
@ned-deily ned-deily reopened this May 29, 2019
@ned-deily ned-deily changed the title bpo-33006 - Correct filter doc string to clarify 2nd argument can be iterable [2.7] bpo-33006 - Correct filter doc string to clarify 2nd argument can be iterable May 29, 2019
@miss-islington
Copy link
Contributor

@TonyFlury: Status check is done, and it's a success ✅ .

@miss-islington miss-islington merged commit 09ba833 into python:2.7 May 29, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants