clarify that :compact prohibition on line breaks is for 2-arg show #55489
Conversation
This file contains 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
stevengj
added
docs
matthias314
reviewed
Aug 14, 2024
| @@ -352,7 +352,7 @@ The following properties are in common use: | |||
|
|
|||
| - `:compact`: Boolean specifying that values should be printed more compactly, e.g. | |||
| that numbers should be printed with fewer digits. This is set when printing array | |||
| elements. `:compact` output should not contain line breaks. | |||
| elements. `:compact` output for 2-argument [`show(io, x)`](@ref) should not contain line breaks. | |||
There was a problem hiding this comment.
Suggested change
| elements. `:compact` output for 2-argument [`show(io, x)`](@ref) should not contain line breaks. | |
| elements. `:compact` output should not contain line breaks. | |
| This flag may be ignored for 3-argument [`show(io, mime, x)`](@ref). |
I guess that this is what show for arrays and dictionaries does at present (apart from passing :compact on to the elements). It would also keep readers from asking themselves what "compact output with line breaks" may look like.
As expressed in the referenced Discourse thread, I would personally find a compact (human-readable) 3-argument show version quite useful. For this reason I suggest to add
Nevertheless, users are encouraged to take the `:compact` flag into account
when writing 3-argument `show` methods for the `"text/plain"` MIME type.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The docs say that
:compact=>truein theIOContextmeans that the output should not contain line breaks. Clarify that this is for the 2-argumentshow(io, x)output.(As opposed to 3-arg
show, whose whole purpose has always been to enable verbose multi-line display, and which is normally only called at the top level bydisplay, not for nested objects).See also this discourse thread.