Revising DocC content for the CLI commands to be able to read the arguments for the commands #8883
+2,025
−58
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
heckj
requested review from
jakepetroules,
dschaefer2 and
shawnhyam
as code owners
heckj
requested review from
bripeticca,
plemarquand,
owenv,
bkhouri,
cmcgee1024 and
daveyc123
as code owners
owenv
approved these changes
Jul 1, 2025
jakepetroules
approved these changes
Jul 1, 2025
|
@swift-ci please test |
bripeticca
approved these changes
Jul 3, 2025
|
@swift-ci please test windows |
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.
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.