Updates output to present the string representation of command arguments to a wrapped text block #791
Conversation
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
rauhul
approved these changes
Jun 30, 2025
Arguments switched from a single long line within a preformatted text block to multilines and wrapped to a line length. This makes the output significantly easier to read when there's a large number of options (for example, the `swift build` command). The wrapping algorithm is a simple greedy algorithm that extends up to, but not beyond, a maximum text width. The line length defined by the style of output (markdown - 80, docc - 60) - Snapshot tests for output updated to reflect changes
heckj
force-pushed
the
docc-options-list-update
branch
from
3d160f6 to
a33d4af
Compare
|
(rebased the formatting into the commit and reset over top of tree) |
4 tasks
dschaefer2
pushed a commit
to swiftlang/swift-package-manager
that referenced
this pull request
Jul 7, 2025
…uments for the commands (#8883) Updates to all existing CLI reference documentation to make CLI arguments readable. ### Motivation: The initial run of the argument parser generator dumped the arguments into a single, concatenated string that ended up being pretty unreadable through DocC. This update fixes that to present the arguments in a wrapped-width code block, aligned at 60 characters to make it easier to read in DocC. This matches the PR being made to swift argument parser to revise the generation of that content: apple/swift-argument-parser#791 ### Modifications: Updated the CLI arguments to block formatting for all existing CLI reference documentation pages. ### Result: The arguments for any of the CLI documents are much easier to read.
marcprux
pushed a commit
to swift-everywhere/swift-package-manager
that referenced
this pull request
Jul 7, 2025
…uments for the commands (swiftlang#8883) Updates to all existing CLI reference documentation to make CLI arguments readable. The initial run of the argument parser generator dumped the arguments into a single, concatenated string that ended up being pretty unreadable through DocC. This update fixes that to present the arguments in a wrapped-width code block, aligned at 60 characters to make it easier to read in DocC. This matches the PR being made to swift argument parser to revise the generation of that content: apple/swift-argument-parser#791 Updated the CLI arguments to block formatting for all existing CLI reference documentation pages. The arguments for any of the CLI documents are much easier to read.
|
@natecook1000 would love your eyes on this for a quick review, just to make sure this is remaining aligned (per @rauhul) |
|
@swift-ci please test |
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.
Arguments switched from a single long line within a preformatted text block to multilines and wrapped to a line length. This makes the output significantly easier to read when there's a large number of options (for example, the
swift buildcommand). The wrapping algorithm is a simple greedy algorithm that extends up to, but not beyond, a maximum text width.The line length is defined by the style of output (markdown: 80, docc: 60)
Checklist