Skip to content
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

bpo-39377: json: Update doc about the encoding option. #18076

Merged
merged 9 commits into from Jan 22, 2020

Conversation

@methane
Copy link
Member

methane commented Jan 20, 2020

Copy link
Member

aeros left a comment

I have a couple of minor grammar suggestions. Other than that, LGTM.

Doc/library/json.rst Outdated Show resolved Hide resolved
Python 3.1, it was deprecated and ignored. And using it was emitting
:exc:`DeprecationWarning` since Python 3.8.
Comment on lines 430 to 431

This comment has been minimized.

Copy link
@aeros

aeros Jan 20, 2020

Member
Python 3.1, it was deprecated and ignored. As of Python 3.8, using it
emitted a :exc:`DeprecationWarning`.

This comment has been minimized.

Copy link
@methane

methane Jan 21, 2020

Author Member

I'm not good at English so I don't understand the difference between current sentence and your suggestion.
I just copied upper entry and edit. If I should change "using it was emitting..." to "using it emitted", shoud I change the upper entry too?

This comment has been minimized.

Copy link
@ammaraskar

ammaraskar Jan 21, 2020

Member

Yeah, "emitted" is better since we're talking about a past version. Feel free to change was emitting -> emitted on the entry above as well.

Co-Authored-By: Kyle Stanley <aeros167@gmail.com>
@ammaraskar

This comment has been minimized.

Copy link
Member

ammaraskar commented Jan 21, 2020

As Victor mentioned on the bpo issue, let's also note this in https://github.com/python/cpython/blob/master/Doc/whatsnew/3.9.rst#removed

@methane

This comment has been minimized.

Copy link
Member Author

methane commented Jan 21, 2020

@ammaraskar Do you mean, I don't do it in this pull request?
Am I editing wrong place?

@ammaraskar

This comment has been minimized.

Copy link
Member

ammaraskar commented Jan 21, 2020

Oh sorry, my mistake, it is in the right place.

Copy link
Member

ammaraskar left a comment

LGTM with Kyle's suggestion.

methane added 2 commits Jan 21, 2020
(Contributed by Victor Stinner in :issue:`39357`.)

* The *encoding* parameter of :func:`json.loads` has been removed. As of
Python 3.1, it was deprecated and ignored. And using it emitted a

This comment has been minimized.

Copy link
@aeros

aeros Jan 21, 2020

Member

One last point: I'd suggest starting the third sentence without the "And" or combining the sentences using a semicolon. Also, after reading over it again, I realized it would be more grammatically correct to write "using it has emitted" rather than "using it emitted". Here's a couple of examples:

  1. As of Python 3.1, it was deprecated and ignored. Using it has emitted a :exc:DeprecationWarning since Python 3.8.

  2. As of Python 3.1, it was deprecated and ignored; using it has emitted a :exc:DeprecationWarning since Python 3.8.

Option (2) is likely more formally correct, but I think either would be fine.

Note: As a general English grammar rule, it's perfectly acceptable to start sentences with "And" (https://www.merriam-webster.com/words-at-play/words-to-not-begin-sentences-with), but it's typically discouraged to string together consecutive "and"s, even if they're separated by a period.

This comment has been minimized.

Copy link
@aeros

aeros Jan 21, 2020

Member

In the future if you'd like me to review any documentation PRs or news entries for help with English grammar, I'd be happy to help! Feel free to request a review or @ mention me.

My primary areas of interest recently have been in asyncio, concurrent.futures, and subinterpreters, but I'm always glad to help with improving our documentation and news entries when I have the chance.

Also, I think your English skills are actually quite decent @methane, especially for someone who's native language is entirely dissimilar to English. I can generally understand the message you're trying to convey, there's just a few grammatical components that could be improved to make it more formally correct.

Doc/whatsnew/3.9.rst Outdated Show resolved Hide resolved
methane and others added 3 commits Jan 22, 2020
Co-Authored-By: Kyle Stanley <aeros167@gmail.com>
@aeros
aeros approved these changes Jan 22, 2020
@methane

This comment has been minimized.

Copy link
Member Author

methane commented Jan 22, 2020

Thank you for your review!

@methane methane merged commit 5bbac8c into python:master Jan 22, 2020
5 checks passed
5 checks passed
Docs
Details
Azure Pipelines PR #20200122.13 succeeded
Details
bedevere/issue-number Issue number 39377 found
Details
bedevere/news "skip news" label found
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@methane methane deleted the methane:remove-json-encoding branch Jan 22, 2020
sthagen added a commit to sthagen/cpython that referenced this pull request Jan 22, 2020
bpo-39377: json: Update doc about the encoding option. (pythonGH-18076)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
5 participants
You can’t perform that action at this time.