docs: Add reference documentation for plugin#109
Merged
euanh merged 1 commit intoapple:mainfrom Apr 24, 2025
Merged
Conversation
05281d5 to
db7e859
Compare
heckj
approved these changes
Apr 24, 2025
Collaborator
heckj
left a comment
There was a problem hiding this comment.
I'm guessing you created this by hand vs. using the generator command plug in swift argument parser? (I suspect by hand, as I don't think the plugin uses term lists unless you used the most recent build where I just added it)
The term lists are a great touch here!
db7e859 to
c8925f4
Compare
Collaborator
Author
|
Yes, I did this by hand. I started with the help output for I don't think it's currently possible to generate help for a plugin itself because plugins can't use |
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
2 participants
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.
Motivation
Reference documentation, such as manual pages, complements getting started guides and tutorials by explaining a tool's interface and options in one place.
The
build-container-imagecommand plugin is the main user-facing tool in the project, so users will benefit from having reference documentation for it, available from the main documentation site.At present,
containertoolwill mostly be used through the plugin, which is a thin wrapper which callscontainertoolas a helper. Documentingcontainertoolas a separate tool might be confusing. It has command line help for those who need to use it directly, and as the plugin is largely a wrapper its reference documentation also explains most ofcontainertool's options.Modifications
containertoolmanual page for thebuild-container-imageplugin.Result
Users have access to reference documentation which explains the interface and options of the
build-container-imagecommand plugin.Test Plan
All existing tests continue to pass.