Skip to content

Update pickle.rst - #14128

Merged
willingc merged 3 commits into
python:masterfrom
geryogam:patch-7
Aug 7, 2019
Merged

willingc merged 3 commits into
python:masterfrom
geryogam:patch-7

Conversation

@geryogam

@geryogam geryogam commented Jun 16, 2019 •

Copy link
Copy Markdown
Contributor

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.

@mangrisano mangrisano 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.

Hi, thank you for the pull request.

I've left a suggestion about the change.

Thank you. :)

Comment thread Doc/library/pickle.rst Resolved

@mangrisano mangrisano 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.

LGTM. Thank you.

@willingc

Copy link
Copy Markdown
Contributor

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

Comment thread Doc/library/pickle.rst Resolved
@geryogam

geryogam commented Jun 24, 2019 •

Copy link
Copy Markdown
Contributor Author

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

geryogam commented Aug 6, 2019

Copy link
Copy Markdown
Contributor Author

@willingc

@willingc

willingc commented Aug 7, 2019

Copy link
Copy Markdown
Contributor

Thanks @maggyero 👍

@geryogam
geryogam deleted the patch-7 branch August 7, 2019 05:32
@geryogam

geryogam commented Aug 7, 2019

Copy link
Copy Markdown
Contributor Author

Thanks for reviewing this @willingc.

lisroach pushed a commit to lisroach/cpython that referenced this pull request Sep 10, 2019
* Edits for readability and grammar
@geryogam

Copy link
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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
* Edits for readability and grammar
(cherry picked from commit 362f535)

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

Copy link
Copy Markdown

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

@bedevere-bot

Copy link
Copy Markdown

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
* 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
* 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
* Edits for readability and grammar
(cherry picked from commit 362f535)

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

Copy link
Copy Markdown
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
* Edits for readability and grammar
websurfer5 pushed a commit to websurfer5/cpython that referenced this pull request Jul 20, 2020
* Edits for readability and grammar
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 issue skip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants