Skip to content

gh-146061: Fix contradicting sentences in json docs#146095

Open
jonathandung wants to merge 16 commits intopython:mainfrom
jonathandung:main
Open

gh-146061: Fix contradicting sentences in json docs#146095
jonathandung wants to merge 16 commits intopython:mainfrom
jonathandung:main

Conversation

@jonathandung
Copy link
Contributor

@jonathandung jonathandung commented Mar 17, 2026

Closes #146061.

Changed the description under the indent parameter to json.dump, such that it no longer opposes that under separators.


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

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news labels Mar 17, 2026
@python-cla-bot
Copy link

python-cla-bot bot commented Mar 17, 2026

All commit authors signed the Contributor License Agreement.

CLA signed

@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Mar 17, 2026
@picnixz picnixz changed the title gh-146061: Fix contradicting sentences in [json docs](https://github.com/python/cpython/blob/main/Doc/library/json.rst) gh-146061: Fix contradicting sentences in json docs Mar 18, 2026
@jonathandung
Copy link
Contributor Author

PR edited. See @serhiy-storchaka's comment.

Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also update the docstring for dumps().

@jonathandung
Copy link
Contributor Author

Also update the docstring for dumps().

Done

@jonathandung
Copy link
Contributor Author

Please review

@eendebakpt
Copy link
Contributor

@jonathandung Most python developers are volunteers, so it can take a bit of time before your PR gets (another) review. Also see the dev guide https://devguide.python.org/getting-started/pull-request-lifecycle/#reviewing

@jonathandung
Copy link
Contributor Author

Understood, thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting core review docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

Contradictory sentences in json docs

3 participants