8000 Update pickle.rst by geryogam · Pull Request #14128 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

Update pickle.rst #14128

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Aug 7, 2019
Merged

Update pickle.rst #14128

merged 3 commits into from
Aug 7, 2019

Conversation

geryogam
Copy link
Contributor
@geryogam geryogam commented Jun 16, 2019 •
edited
Loading

This PR will apply the following modifications to the pickle module documentation:

  • replace the indefinite article "a" with the definite article "the" where appropriate;
  • add missing parameter references obj or bytes_obj in function descriptions;
  • remove the verb "Read" in a function description with a non-file object parameter;
  • replace some "persistent id" with "persistent ID" for a consistent case.

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Jun 16, 2019
mangrisano
mangrisano suggested changes Jun 16, 2019
View reviewed changes
Copy link
Contributor
@mangrisano mangrisano left a comment

Choose a reason for hiding this comment

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

Hi, thank you for the pull request.

I've left a suggestion about the change.

Thank you. :)

mangrisano
mangrisano approved these changes Jun 16, 2019
View reviewed changes
Copy link
Contributor
@mangrisano mangrisano left a comment

Choose a reason for hiding this comment

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

LGTM. Thank you.

@willingc
Copy link
Contributor

Hi @maggyero, Thanks for the PR. Did this PR address an open issue on bugs.python.org?

willingc
willingc reviewed Jun 24, 2019
View reviewed changes
@geryogam
Copy link
Contributor Author
geryogam commented Jun 24, 2019 •
edited
Loading

Hi @maggyero, Thanks for the PR. Did this PR address an open issue on bugs.python.org?

Hello @willingc, thanks for reviewing it. No, I did not open an issue as this PR is only about syntax improvements in the documentation.

@geryogam
Copy link
Contributor Author
geryogam commented Aug 6, 2019

@willingc

@willingc willingc merged commit 362f535 into python:master Aug 7, 2019
@willingc
Copy link
Contributor
willingc commented Aug 7, 2019

Thanks @maggyero 👍

@geryogam geryogam deleted the patch-7 branch August 7, 2019 05:32
@geryogam
Copy link
Contributor Author
geryogam commented Aug 7, 2019

Thanks for reviewing this @willingc.

lisroach pushed a commit to lisroach/cpython that referenced this pull request Sep 10, 2019
@geryogam @lisroach
Update pickle.rst (pythonGH-14128)
94a434b 
* Edits for readability and grammar
@geryogam
Copy link
Contributor Author

By the way @willingc, usually these documentation improvements are backported to the 3.7 and 3.8 branches (like in my PRs #14274, #14098, #14061). Could we do it as well for this PR?

@miss-islington
Copy link
Contributor

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

@miss-islington
Copy link
Contributor

Thanks @maggyero for the PR, and @willingc for merging it 🌮🎉.. I'm working now to backport this PR to: 3.7.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 12, 2019
@geryogam @miss-islington
Update pickle.rst (pythonGH-14128)
b2ed7db 
* Edits for readability and grammar
(cherry picked from commit 362f535)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
@bedevere-bot
Copy link

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

@bedevere-bot
Copy link

GH-16015 is a backport of this pull request to the 3.7 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 12, 2019
@geryogam @miss-islington
Update pickle.rst (pythonGH-14128)
fc80463 
* Edits for readability and grammar
(cherry picked from commit 362f535)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
matrixise pushed a commit that referenced this pull request Sep 12, 2019
@miss-islington @geryogam @matrixise
Doc: Update pickle.rst (GH-14128) (GH-16014)
eb19c45 
* Edits for readability and grammar
(cherry picked from commit 362f535)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
matrixise pushed a commit that referenced this pull request Sep 12, 2019
Doc: Update pickle.rst (GH-14128) (GH-16015)
ff2a5c0 
* Edits for readability and grammar
(cherry picked from commit 362f535)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
@matrixise
Copy link
Member

Thank you for your contribution @maggyero

@willingc I have merged the backports, thank you for the reviews.

DinoV pushed a commit to DinoV/cpython that referenced this pull request Jan 14, 2020
@geryogam @DinoV
Update pickle.rst (pythonGH-14128)
35c5c52 
* Edits for readability and grammar
websurfer5 pushed a commit to websurfer5/cpython that referenced this pull request Jul 20, 2020
@geryogam @websurfer5
Update pickle.rst (pythonGH-14128)
b099d62 
* Edits for readability and grammar
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@willingc willingc willingc approved these changes

@mangrisano mangrisano mangrisano approved these changes

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@geryogam @willingc @miss-islington @bedevere-bot @matrixise @mangrisano @the-knights-who-say-ni
0