bpo-39377: json: Update doc about the encoding option. #18076
Conversation
Doc/whatsnew/3.9.rst
Outdated
| Python 3.1, it was deprecated and ignored. And using it was emitting | ||
| :exc:`DeprecationWarning` since Python 3.8. |
There was a problem hiding this comment.
Python 3.1, it was deprecated and ignored. As of Python 3.8, using it
emitted a :exc:`DeprecationWarning`.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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 <[email protected]>
|
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 |
|
@ammaraskar Do you mean, I don't do it in this pull request? |
|
Oh sorry, my mistake, it is in the right place. |
Doc/whatsnew/3.9.rst
Outdated
| (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 |
There was a problem hiding this comment.
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:
-
As of Python 3.1, it was deprecated and ignored. Using it has emitted a :exc:
DeprecationWarningsince Python 3.8. -
As of Python 3.1, it was deprecated and ignored; using it has emitted a :exc:
DeprecationWarningsince 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.
There was a problem hiding this comment.
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.
Co-Authored-By: Kyle Stanley <[email protected]>
|
Thank you for your review! |
bpo-39377: json: Update doc about the encoding option. (pythonGH-18076)
Co-authored-by: Kyle Stanley <[email protected]>
https://bugs.python.org/issue39377