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
Appearance settings

bpo-29981: Update Index for set, dict, and generator 'comprehensions'#20272

Merged
akuchling merged 7 commits into
python:masterpython/cpython:masterfrom
DahlitzFlorian:fix-issue-29981DahlitzFlorian/cpython:fix-issue-29981Copy head branch name to clipboard
Oct 20, 2020
Merged

bpo-29981: Update Index for set, dict, and generator 'comprehensions'#20272
akuchling merged 7 commits into
python:masterpython/cpython:masterfrom
DahlitzFlorian:fix-issue-29981DahlitzFlorian/cpython:fix-issue-29981Copy head branch name to clipboard

Conversation

@DahlitzFlorian

@DahlitzFlorian DahlitzFlorian commented May 20, 2020 •
edited by bedevere-bot
Loading

Copy link
Copy Markdown
Contributor

A similar PR (#995) was made back in 2017, but was closed due to inactivity. With this PR I propose nearly the same changes.

@terryjreedy mentioned that he does not like the "all or part of" phrase. As the already existing list comprehension's glossary entry has a similar phrasing, I suggest to keep it.

I build the changes locally and the index was updated accordingly.

https://bugs.python.org/issue29981

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels May 20, 2020
@terryjreedy terryjreedy self-assigned this May 21, 2020
remilapeyre
remilapeyre reviewed Jun 5, 2020
View reviewed changes

@remilapeyre remilapeyre left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Thanks for improving the documentation @DahlitzFlorian !

Comment thread Doc/glossary.rst Outdated
Comment thread Doc/glossary.rst Outdated
Comment thread Doc/glossary.rst Outdated
Comment thread Doc/glossary.rst Outdated
Comment thread Doc/library/stdtypes.rst Outdated
Comment thread Doc/library/stdtypes.rst Outdated
Comment thread Doc/library/stdtypes.rst Outdated
Comment thread Doc/library/stdtypes.rst
Comment thread Doc/library/stdtypes.rst
Comment thread Doc/library/stdtypes.rst
@DahlitzFlorian
Apply suggestions from @remilapeyre
24d507c 
Co-authored-by: Rémi Lapeyre <remi.lapeyre@henki.fr>
@DahlitzFlorian

DahlitzFlorian commented Jun 6, 2020

Copy link
Copy Markdown
Contributor Author

Thanks @remilapeyre for the review! I applied some of your suggestions. However, I would not change Use to Using as Use is the imperative form and highly preferred. See also: https://github.com/python/cpython/pull/995/files#r120774265

akuchling
akuchling suggested changes Jun 11, 2020
View reviewed changes

@akuchling akuchling left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The text reads well. I only noticed two minor grammar corrections. Thanks!

Comment thread Doc/glossary.rst Outdated
Comment thread Doc/glossary.rst Outdated
@akuchling akuchling self-assigned this Jun 11, 2020
@DahlitzFlorian

DahlitzFlorian commented Jun 11, 2020

Copy link
Copy Markdown
Contributor Author

Thanks for the review @akuchling, I applied the requested changes.

@DahlitzFlorian DahlitzFlorian requested a review from akuchling June 13, 2020 13:12
@DahlitzFlorian

DahlitzFlorian commented Aug 11, 2020

Copy link
Copy Markdown
Contributor Author

Thanks for accepting the PR @akuchling! Is there anything left to do or can it be merged?

@akuchling

akuchling commented Oct 19, 2020

Copy link
Copy Markdown
Contributor

@DahlitzFlorian: on re-reviewing this, can you please move the 'Sets/Dicts can be created...' paragraphs in stdtypes.rst so they come after the paragraph that begins "Return a set/dict"? I think it reads oddly to have the second paragraph begin "Return ".

@DahlitzFlorian

DahlitzFlorian commented Oct 20, 2020

Copy link
Copy Markdown
Contributor Author

@akuchling changed it accordingly, thanks for the hint!

@terryjreedy

terryjreedy commented Oct 20, 2020

Copy link
Copy Markdown
Member

Without looking at the resulting html, the additions look good to me. I think this should have a news entry such as:
"Improve documentation of sets and dicts, including new glossary entries for dictionary and set comprehensions."

@akuchling

akuchling commented Oct 20, 2020

Copy link
Copy Markdown
Contributor

I think most documentation changes don't need a news entry, unless they're doing something large like adding a section or a whole new document. "Improved docs on topic X" doesn't tell you very much, and users don't need to modify code to accommodate doc changes.

@akuchling akuchling merged commit 2d55aa9 into python:master Oct 20, 2020
@miss-islington

miss-islington commented Oct 20, 2020

Copy link
Copy Markdown
Contributor

Thanks @DahlitzFlorian for the PR, and @akuchling for merging it 🌮🎉.. I'm working now to backport this PR to: 3.8, 3.9.
🐍🍒⛏🤖

@bedevere-bot

bedevere-bot commented Oct 20, 2020

Copy link
Copy Markdown

GH-22836 is a backport of this pull request to the 3.9 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 20, 2020
@DahlitzFlorian @miss-islington
bpo-29981: Add examples and update index for set, dict, and generator…
4593c2c 
… comprehensions'(pythonGH-20272)

Co-authored-by: Rémi Lapeyre <remi.lapeyre@henki.fr>
(cherry picked from commit 2d55aa9)

Co-authored-by: Florian Dahlitz <f2dahlitz@freenet.de>
@bedevere-bot

bedevere-bot commented Oct 20, 2020

Copy link
Copy Markdown

GH-22837 is a backport of this pull request to the 3.8 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 20, 2020
@DahlitzFlorian @miss-islington
bpo-29981: Add examples and update index for set, dict, and generator…
081b01c 
… comprehensions'(pythonGH-20272)

Co-authored-by: Rémi Lapeyre <remi.lapeyre@henki.fr>
(cherry picked from commit 2d55aa9)

Co-authored-by: Florian Dahlitz <f2dahlitz@freenet.de>
@terryjreedy

terryjreedy commented Oct 21, 2020

Copy link
Copy Markdown
Member

I have a lower threshhold -- is something added that users might want to read. But whoever does the work to push a PR over the finish line gets to decide.

@DahlitzFlorian

DahlitzFlorian commented Oct 21, 2020

Copy link
Copy Markdown
Contributor Author

Thanks for the guidance @remilapeyre and @akuchling 🎉

@DahlitzFlorian DahlitzFlorian deleted the fix-issue-29981 branch October 21, 2020 05:44
miss-islington added a commit that referenced this pull request Oct 25, 2020
@miss-islington @DahlitzFlorian
bpo-29981: Add examples and update index for set, dict, and generator…
60bef61 
… comprehensions'(GH-20272)

Co-authored-by: Rémi Lapeyre <remi.lapeyre@henki.fr>
(cherry picked from commit 2d55aa9)

Co-authored-by: Florian Dahlitz <f2dahlitz@freenet.de>
miss-islington added a commit that referenced this pull request Oct 25, 2020
@miss-islington @DahlitzFlorian
bpo-29981: Add examples and update index for set, dict, and generator…
2cccc29 
… comprehensions'(GH-20272)

Co-authored-by: Rémi Lapeyre <remi.lapeyre@henki.fr>
(cherry picked from commit 2d55aa9)

Co-authored-by: Florian Dahlitz <f2dahlitz@freenet.de>
adorilson pushed a commit to adorilson/cpython that referenced this pull request Mar 13, 2021
@DahlitzFlorian @adorilson
bpo-29981: Add examples and update index for set, dict, and generator…
ef6ecbd 
… comprehensions'(pythonGH-20272)

Co-authored-by: Rémi Lapeyre <remi.lapeyre@henki.fr>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@remilapeyre remilapeyre remilapeyre left review comments

@akuchling akuchling akuchling approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@akuchling akuchling

@terryjreedy terryjreedy

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@DahlitzFlorian @akuchling @terryjreedy @miss-islington @bedevere-bot @remilapeyre @the-knights-who-say-ni
Morty Proxy This is a proxified and sanitized view of the page, visit original site.