Document what constitutes public API #2175
Merged
Conversation
This file contains 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
Motivation: SemVer packages should descibe what constitutes their API. Modifications: - Add a doc explaining what the public API is Result: More docs
gjcairo
approved these changes
Jan 23, 2025
|
|
||
| ### Library targets | ||
|
|
||
| All library targets made available as package products as considered to be |
There was a problem hiding this comment.
Suggested change
| All library targets made available as package products as considered to be | |
| All library targets made available as package products are considered to be |
Comment on lines
+10
to
+11
| part of the public API; commitments the maintainers make relating to the API; | ||
| and guidelines for users. |
There was a problem hiding this comment.
Suggested change
| part of the public API; commitments the maintainers make relating to the API; | |
| and guidelines for users. | |
| part of the public API, commitments the maintainers make relating to the API, | |
| and guidelines for users. |
| part of the public API; commitments the maintainers make relating to the API; | ||
| and guidelines for users. | ||
|
|
||
| For clarity the project is comprised of the following Swift packages: |
There was a problem hiding this comment.
Suggested change
| For clarity the project is comprised of the following Swift packages: | |
| For clarity, the project is comprised of the following Swift packages: |
|
Ah, didn't notice auto merge had been enabled. It's fine, would be cool if you fixed these things in a follow-up though |
glbrntt
added a commit
to glbrntt/grpc-swift
that referenced
this pull request
Jan 23, 2025
Motivation: Some comments on grpc#2175 were missed becuase automerge was enabled and the PR got approved. Modification: Fix typos/punctuation. Result: Better docs.
Merged
glbrntt
added a commit
that referenced
this pull request
Jan 24, 2025
Motivation: Some comments on #2175 were missed becuase automerge was enabled and the PR got approved. Modification: Fix typos/punctuation. Result: Better docs.
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.
Motivation:
SemVer packages should descibe what constitutes their API.
Modifications:
Result:
More docs