Standardise some naming #2063
Merged
Standardise some naming #2063
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
gjcairo
requested changes
Sep 18, 2024
| /// the server code translation or the client code translation. | ||
| protocol SpecializedTranslator { | ||
|
|
||
| /// The ``SourceGenerator.Configuration.AccessLevel`` object used to represent the visibility level used in the generated code. |
There was a problem hiding this comment.
Docs are outdated here. Would you mind trying to build docs to see which other references may have broken?
There was a problem hiding this comment.
Yes, good catch. We should add a docc CI check as well.
There was a problem hiding this comment.
Ah, these were missed because DocC by default only checks public symbols. You can change that to internal if you use the docc-plugin (e.g. swift package generate-documentation --target GRPCCore --symbol-graph-minimum-access-level internal).
This surfaced a fair few issues with internal docs. I fixed a few, and ones introduced by this change, but I think we should tackle the rest separately.
Motivation: In v2 we've predominantly used 'max' instead of 'maximum' and 'config' instead of 'configuration'. We should apply these consistently. Modifications: - Replaces occurrences of 'maximum' with 'max', and 'configuration' with 'config'. Result: More consistent naming
glbrntt
force-pushed
the
v2/max-config
branch
from
1559c34 to
f10d872
Compare
glbrntt
force-pushed
the
v2/max-config
branch
from
f10d872 to
5d80372
Compare
gjcairo
approved these changes
Sep 19, 2024
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:
In v2 we've predominantly used 'max' instead of 'maximum' and 'config' instead of 'configuration'. We should apply these consistently.
Modifications:
Result:
More consistent naming