gh-146061: Fix contradicting sentences in json docs#146095
Merged
Merged
Conversation
|
All commit authors signed the Contributor License Agreement. |
picnixz
changed the title
eendebakpt
reviewed
Mar 18, 2026
Co-authored-by: Pieter Eendebak <pieter.eendebak@gmail.com>
Contributor
Author
|
PR edited. See @serhiy-storchaka's comment. |
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
eendebakpt
approved these changes
Mar 19, 2026
| object members will be pretty-printed with that indent level. An indent | ||
| level of 0 will only insert newlines. ``None`` is the most compact | ||
| representation. | ||
| level of 0 will only insert newlines. ``None`` gives a compact |
Member
There was a problem hiding this comment.
If ``indent`` is ``None`` (the default), no newlines are inserted.
Member
There was a problem hiding this comment.
This is not true. indent=None does not give a compact representation. indent=None gives the result of the same size as indent=0. I would not mention compactness here, it is misleading.
Contributor
Author
There was a problem hiding this comment.
It does give a compact representation.
> python -c "print(__import__('json').dumps([{'a': 1, 'b': [2, 3], 'c': {'d': 4, 'e': [5, 6]}}, 7]))"
[{"a": 1, "b": [2, 3], "c": {"d": 4, "e": [5, 6]}}, 7]
> python -c "print(__import__('json').dumps([{'a': 1, 'b': [2, 3], 'c': {'d': 4, 'e': [5, 6]}}, 7], indent=None))"
[{"a": 1, "b": [2, 3], "c": {"d": 4, "e": [5, 6]}}, 7]
> python -c "print(__import__('json').dumps([{'a': 1, 'b': [2, 3], 'c': {'d': 4, 'e': [5, 6]}}, 7], indent=0))"
[
{
"a": 1,
"b": [
2,
3
],
"c": {
"d": 4,
"e": [
5,
6
]
}
},
7
]
Member
There was a problem hiding this comment.
The term "compact" is ambiguous and misleading. It is not explicitly defined, and the only example for compact encoding uses separators=(',', ':'). It can be understood as a synonym of "the most compact".
What index=None does is making the output single-line, or not inserting newlines.
Contributor
Author
There was a problem hiding this comment.
I did tell the users to see below, which would direct their attention to the separators argument where this is explained. However, I am open to changing the phrasing.
Member
serhiy-storchaka
left a comment
serhiy-storchaka
left a comment
There was a problem hiding this comment.
Also update the docstring for dumps().
Contributor
Author
|
Please review |
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 |
Contributor
Author
|
Understood, thanks |
Documentation build overview
|
serhiy-storchaka
added
needs backport to 3.13
|
Thanks @jonathandung for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14, 3.15. |
|
GH-149667 is a backport of this pull request to the 3.15 branch. |
bedevere-app
Bot
removed
the
needs backport to 3.15
|
GH-149668 is a backport of this pull request to the 3.14 branch. |
|
GH-149669 is a backport of this pull request to the 3.13 branch. |
serhiy-storchaka
pushed a commit
that referenced
this pull request
May 11, 2026
serhiy-storchaka
pushed a commit
that referenced
this pull request
May 11, 2026
serhiy-storchaka
pushed a commit
that referenced
this pull request
May 11, 2026
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #146061.
Changed the description under the
indentparameter tojson.dump, such that it no longer opposes that underseparators.📚 Documentation preview 📚: https://cpython-previews--146095.org.readthedocs.build/