-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Docs/package plugin api docs #8901
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
…tracts across the public API of the module, resolving warnings for doc comments to argument mismatches
@swift-ci please test |
cc @zkiraly - I'm sure I've likely missed phrasing and editing for doc comments in DevPubs style and conventions. If you've time and inclination, I'd love a review to help point out the missed/incorrect pieces and places. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a couple of comments, going to take another pass at this just to be sure that I caught everything!
Co-authored-by: Bri Peticca <[email protected]>
@swift-ci please test |
Creates a documentation catalog and edits the content to provide public documentation for the Package Plugin API
resolves #8827
Motivation:
The Package Plugin API is required when creating swift package manager plugins, but doesn't have publicly hosted documentation today. This resolves that by creating the documentation catalog, adding curation (organization), and editing the documentation content to match.
Modifications:
Result:
The potential to build a documentation archive for the Package Plugin API.
Preview the contents of this PR using the command: