Repository navigation
Conversation
Signed-off-by: Sebastian Turner <sebastiant3484@gmail.com>
sebxt
force-pushed
the
fix/docc-reference-short-only-names
branch
from
October 17, 2026 23:18
4ce93ff to
192957a
Compare
This branch has not been deployed
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
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.
generate-docc-referenceonly kept long names when rendering a flag or option, so an argument declared with only a short name (@Flag(name: .short) var verbose) or only a single dash name was rendered as[--]in the usage block and as--in the argument list. Options came out as--=<value>.This change keeps using the long names when an argument has any, so existing output is unchanged. When an argument has no long name it now falls back to its preferred name with the right prefix, for example
[-v]and-n=<n>. The name selection is shared byusage()andidentity()in a small helper.To cover it, the
default-as-flagexample gets a short only-vflag, and the DocC reference tests now run against that example in both styles. The two existingdefault-as-flagmanual snapshots are updated for the new flag; they already rendered short only names correctly. Without the fix the new reference tests fail with[--]in place of[-v].Tested with
swift teston Linux (Swift 6.2): all 568 tests pass, andswift format lint --strictis clean on the changed files.Checklist
Fixes #989