Skip to content

bpo-40994: Ungroup items in collections.abc documentation for improved clarity #21880

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 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 1 commit into from
Aug 20, 2020

Conversation

sydneypemberton1986
Copy link
Contributor

@sydneypemberton1986 sydneypemberton1986 commented Aug 14, 2020

Use a less surprising document structure.

https://bugs.python.org/issue40994

Automerge-Triggered-By: @csabella

@the-knights-who-say-ni
Copy link

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).

Recognized GitHub username

We couldn't find a bugs.python.org (b.p.o) account corresponding to the following GitHub usernames:

@sydneypemberton1986

This might be simply due to a missing "GitHub Name" entry in one's b.p.o account settings. This is necessary for legal reasons before we can look at this contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

You can check yourself to see if the CLA has been received.

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

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Aug 14, 2020
@iritkatriel
Copy link
Member

I think the title should be, instead of "Clarify documentation using 'respectively' construct", something that says more clearly where the change was made. Something like "Ungroup items in collections.abc documentation for improved clarity".

@sydneypemberton1986
Copy link
Contributor Author

@iritkatriel Thank you so much for the prompt review. I was tangling with the first time setup of a Python PR and I made some pretty bonehead errors there. I've addressed your feedback and am working on straightening out the CLA. I know I signed it but it's not getting associated with my account somehow.

@sydneypemberton1986 sydneypemberton1986 changed the title bpo-40994: Clarify documentation using 'respectively' construct bpo-40994: Ungroup items in collections.abc documentation for improved clarity Aug 14, 2020
@iritkatriel
Copy link
Member

Thank you for addressing the comments. I think the CLA can take a day or two. In the meantime, it would be tidier to squash the two commits into one, so that the commit log is clean.

@sydneypemberton1986
Copy link
Contributor Author

Excellent. I will rebase them.

@sydneypemberton1986
Copy link
Contributor Author

sydneypemberton1986 commented Aug 14, 2020

I have my Github username configured as @sydneypemberton1986 on my B.P.O account.
I'm not exactly sure what counts as my B.P.O. username when signing the CLA. I used the federated login with Google.
I've tried a few variations, maybe I just need to wait.

Edit: I now get a 500 on https://check-python-cla.herokuapp.com/ with @sydneypemberton1986, so, progress?

Copy link
Contributor

@eamanu eamanu left a comment

Choose a reason for hiding this comment

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

Hi, I like this improve, LGTM

@csabella
Copy link
Contributor

@sydneypemberton1986, looking at the user screen on bugs.python.org, I believe you need to remove the '@' at the beginning of the Github name for the bot to be able to match to it. Thanks!

@miss-islington
Copy link
Contributor

Sorry, I can't merge this PR. Reason: Required status check "Travis CI - Pull Request" is expected..

@csabella
Copy link
Contributor

I'm going to close and reopen this to retrigger Travis CI.

@csabella csabella closed this Aug 20, 2020
@csabella csabella reopened this Aug 20, 2020
@miss-islington
Copy link
Contributor

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

1 similar comment
@miss-islington
Copy link
Contributor

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

@miss-islington
Copy link
Contributor

Sorry, I can't merge this PR. Reason: Required status check "Travis CI - Pull Request" is expected..

1 similar comment
@miss-islington
Copy link
Contributor

Sorry, I can't merge this PR. Reason: Required status check "Travis CI - Pull Request" is expected..

@miss-islington
Copy link
Contributor

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

@miss-islington miss-islington merged commit 2ce3963 into python:master Aug 20, 2020
@miss-islington
Copy link
Contributor

Thanks @sydneypemberton1986 for the PR 🌮🎉.. I'm working now to backport this PR to: 3.8, 3.9.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 20, 2020
…d clarity (pythonGH-21880)

Use a less surprising document structure.

Automerge-Triggered-By: @csabella
(cherry picked from commit 2ce3963)

Co-authored-by: Sydney Pemberton <46042811+sydneypemberton1986@users.noreply.github.com>
@bedevere-bot
Copy link

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

@bedevere-bot bedevere-bot removed the needs backport to 3.9 only security fixes label Aug 20, 2020
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 20, 2020
…d clarity (pythonGH-21880)

Use a less surprising document structure.

Automerge-Triggered-By: @csabella
(cherry picked from commit 2ce3963)

Co-authored-by: Sydney Pemberton <46042811+sydneypemberton1986@users.noreply.github.com>
@bedevere-bot
Copy link

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

@csabella
Copy link
Contributor

@sydneypemberton1986 thank you for the contribution and welcome to CPython! 🎉 🎉 🎉

@iritkatriel, @eamanu, and @rhettinger, thank you for the reviews!

@sydneypemberton1986 sydneypemberton1986 deleted the bpo-40994 branch August 20, 2020 13:49
csabella pushed a commit that referenced this pull request Aug 22, 2020
…d clarity (GH-21880) (#21927)

Use a less surprising document structure.

Automerge-Triggered-By: @csabella
(cherry picked from commit 2ce3963)

Co-authored-by: Sydney Pemberton <46042811+sydneypemberton1986@users.noreply.github.com>
csabella pushed a commit that referenced this pull request Aug 22, 2020
…d clarity (GH-21880) (#21926)

Use a less surprising document structure.

Automerge-Triggered-By: @csabella
(cherry picked from commit 2ce3963)

Co-authored-by: Sydney Pemberton <46042811+sydneypemberton1986@users.noreply.github.com>
xzy3 pushed a commit to xzy3/cpython that referenced this pull request Oct 18, 2020
…d clarity (pythonGH-21880)

Use a less surprising document structure.

Automerge-Triggered-By: @csabella
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants