-
-
Notifications
You must be signed in to change notification settings - Fork 30.4k
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
gh-122873: Allow "python3 -m json" to work #122884
Conversation
4a8fdb0
to
2e37475
Compare
Thank you @AA-Turner for reviewing. Let me know if you'd like any variation of the suggestions I commented on made. I just used blurb to add a NEWS.d entry as well. |
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
NEWS.d goes into the full changelog, whatsnes is for bigger or user visible changes. Using the same text for both is fine, you've done the right thing here. A |
We do want both. "What's New" is the main set release notes. This'll be the main document people read about the release (~30k views/month): https://docs.python.org/3.14/whatsnew/3.14.html#json NEWS.d files eventually becomes part of the giant changelog, not read so often (~4k views/month), but can be useful to filter via the search box: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's also change ./Doc/library/cmdline.rst
:
-* :ref:`json.tool <json-commandline>`
+* :ref:`json <json-commandline>`
https://cpython-previews--122884.org.readthedocs.build/en/122884/library/cmdline.html
For the What's New and NEWS.d, shall we also mention python -m json
explicitly, and include a link to the json-commandline
reference?
And there's some json.tool
-> json
we can update in the Lib/json/__init__.py
docstring.
Misc/NEWS.d/next/Library/2024-08-10-14-16-59.gh-issue-122873.XlHaUn.rst
Outdated
Show resolved
Hide resolved
Misc/NEWS.d/next/Library/2024-08-10-14-16-59.gh-issue-122873.XlHaUn.rst
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PR mostly looks good to me, just some comments inline around keeping a minimal level of json.tool
documentation (since the submodule still exists and isn't going anywhere).
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Alyssa Coghlan <ncoghlan@gmail.com>
Co-authored-by: Alyssa Coghlan <ncoghlan@gmail.com>
Co-authored-by: Alyssa Coghlan <ncoghlan@gmail.com>
I think this is almost ready! Please also change -* :ref:`json.tool <json-commandline>`
+* :ref:`json <json-commandline>` https://cpython-previews--122884.org.readthedocs.build/en/122884/library/cmdline.html |
Just updated. I had no idea this page existed. I wish I had known about it when writing my post on Python's CLIs! 😆 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you!
Thanks @treyhunner! A |
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: Alyssa Coghlan <ncoghlan@gmail.com>
Allow
python3 -m json
to work in addition topython3 -m json.tool
and update documentation to usepython3 -m json
instead ofpython3 -m json.tool
.Issue: #122873
📚 Documentation preview 📚: https://cpython-previews--122884.org.readthedocs.build/