Document "line" output format #5571
Merged
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
philrz
commented
Jan 14, 2025
Comment on lines
+403
to
+404
| The `line`, `text`, and `table` formats simplify data to fit within the | ||
| limitations of text-based output. They may be a good fit for use with other text-based shell |
There was a problem hiding this comment.
I decided to keep the details for all three of these formats still in one section but gave line top billing because it comes with the fewest caveats.
This was referenced Jan 14, 2025
nwt
approved these changes
Jan 15, 2025
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.
tl;dr
This adds user-facing docs for the
-f lineoutput format added in #5570.Details
It seemed appropriate to disclose the backslash escape sequences that affect this output. Since the changes in #5570 indicate we hand the job off to Go's
fmt.Fprintln(), I'd normally have been fine just hyperlinking to some kind of table in the Go docs that disclose this info, but I couldn't seem to find such a table. I asked ChatGPT and it also complained that the official docs were sparse, but it did produce a table of its own and I confirmed via black box testing which ones seem to work, so that's what's in my table here. If those of you who know the code can point to a better reference or can spot entries missing from the table, please speak up.While making these changes I noticed that I let the tables for input/output formats get out of alphabetical order in #5387, so I address that here as well.