codes: update docstring to indicate expected usage #6701
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
zasweq
approved these changes
Oct 10, 2023
codes/codes.go
Outdated
Comment on lines
33
to
34
| // other code values. Behavior and interopability are implementation-specific | ||
| // and not guaranteed. |
There was a problem hiding this comment.
Can you clarify the scope of the language of "behavior and interoperability" here? What is not guaranteed? Any permutation of languages with defined status codes? Only status codes undefined?
codes/codes.go
Outdated
| // A Code is an unsigned 32-bit error code as defined in the gRPC spec. | ||
| // A Code is a status code according to the gRPC spec: | ||
| // | ||
| // https://github.com/grpc/grpc/blob/master/doc/statuscodes.md |
There was a problem hiding this comment.
Easwar made me switch urls to a certain format: https://github.com/grpc/grpc-go/blob/master/xds/internal/balancer/wrrlocality/balancer.go#L19 (I think this is a strong heuristic of .go files). Can you please switch this?
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Related to grpc/grpc#34588; specifically document that users should use ONLY the values defined by us.
RELEASE NOTES:
codes.Code