Skip to content

Adjust wording in json.rst for better readability#148956

Closed
manoj-km24 wants to merge 1 commit intopython:mainfrom
manoj-km24:fix-wording-in-json-rst
Closed

Adjust wording in json.rst for better readability#148956
manoj-km24 wants to merge 1 commit intopython:mainfrom
manoj-km24:fix-wording-in-json-rst

Conversation

@manoj-km24
Copy link
Copy Markdown
Contributor

@manoj-km24 manoj-km24 commented Apr 24, 2026

In Doc/library/json.rst the sentence:

If ``True``, dictionaries will be outputted sorted by key.

can be adjusted for better readability like:

If ``True``, dictionaries will be sorted by key and outputted.

📚 Documentation preview 📚: https://cpython-previews--148956.org.readthedocs.build/

@StanFromIreland
Copy link
Copy Markdown
Member

I'm sorry but this is unnecessary IMO, I don't see any particular difference. Did this cause you confusion? How do your proposed changes improve it?

@StanFromIreland StanFromIreland added the pending The issue will be closed if no feedback is provided label Apr 24, 2026
@manoj-km24
Copy link
Copy Markdown
Contributor Author

manoj-km24 commented Apr 25, 2026

I'm sorry but this is unnecessary IMO, I don't see any particular difference. Did this cause you confusion? How do your proposed changes improve it?

Thanks for the feedback. I agree the original sentence isn't confusing. My main concern was the word 'outputted' which seems to be uncommon. So I now believe replacing it with 'output' would be better. I'll update the change accordingly if needed.

@manoj-km24 manoj-km24 closed this Apr 25, 2026
@manoj-km24 manoj-km24 deleted the fix-wording-in-json-rst branch April 25, 2026 01:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting review docs Documentation in the Doc dir pending The issue will be closed if no feedback is provided skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

2 participants