Docs/package plugin api docs #8901
Open
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
…tracts across the public API of the module, resolving warnings for doc comments to argument mismatches
heckj
requested review from
jakepetroules,
dschaefer2,
shawnhyam,
bripeticca,
plemarquand,
owenv,
bkhouri,
cmcgee1024 and
daveyc123
as code owners
|
@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. |
bripeticca
requested changes
Jul 8, 2025
| public protocol Product { | ||
| /// Unique identifier for the product. | ||
| var id: ID { get } | ||
| /// The type that represents the identifier of a packge product. |
There was a problem hiding this comment.
Suggested change
| /// The type that represents the identifier of a packge product. | |
| /// The type that represents the identifier of a package product. |
| /// name, though future SwiftPM versions may allow this to be customized). | ||
| /// The name of the module produced by the target. | ||
| /// | ||
| /// Derived from the target name, though future SwiftPM versions may |
There was a problem hiding this comment.
Since these are API docs I'm unsure as to whether we want to keep the SwiftPM naming or if we prefer Swift package manager here.
| /// The kind of module, describing whether it contains unit tests, contains | ||
| /// The kind of module. | ||
| /// | ||
| /// The kind of module describes whether it contains unit tests, contains |
There was a problem hiding this comment.
Suggested change
| /// The kind of module describes whether it contains unit tests, contains | |
| /// The kind of module describes whether it contains unit tests, |
I'm not beholden to this change, but what do you think? :)
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.
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: