Add generate-docc-reference plugin #694
Merged
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
|
@swift-ci test |
|
@swift-ci test |
cmcgee1024
reviewed
Feb 5, 2025
| return "" | ||
| } | ||
|
|
||
| // TODO: default values, short, etc. |
There was a problem hiding this comment.
thought: It'll be interesting to see how these should be handled in the general case.
There was a problem hiding this comment.
Definitely, I've pinged the documentation workgroup on slack to see if they general ideas.
cmcgee1024
reviewed
Feb 5, 2025
| return "" | ||
| } | ||
|
|
||
| // TODO: default values, values, short, etc. |
Upstreams swiftly's generate-docs-plugin with minimal changes. Adds tests against argument-parser's built in example tools. The initial version of this tool is extremely minimal and should be extended to output much more information contained in tool info, like generate-manual does.
rauhul
force-pushed
the
generate-docc-reference
branch
from
f9e9050 to
7f294c0
Compare
cmcgee1024
reviewed
Feb 5, 2025
| @@ -37,7 +37,6 @@ extension GenerateManualError: CustomStringConvertible { | |||
|
|
|||
| @main | |||
| struct GenerateManual: ParsableCommand { | |||
|
|
|||
There was a problem hiding this comment.
question: Maybe this change doesn't need to be here?
There was a problem hiding this comment.
yeah but it annoyed me and I didn't feel like an independent PR to fix just that line 🙈
I want this stuff to handled by a formatting workflow but I need the infra owners to turn on GitHub actions. Which I keep asking for.
natecook1000
reviewed
Feb 5, 2025
Co-authored-by: Nate Cook <natecook@apple.com>
|
@swift-ci 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.
Upstreams swiftly's generate-docs-plugin with minimal changes. Adds
tests against argument-parser's built in example tools.
The initial version of this tool is extremely minimal and should be
extended to output much more information contained in tool info, like
generate-manual does.