Skip to content

codes: update docstring to indicate expected usage #6701

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Oct 10, 2023
Merged

codes: update docstring to indicate expected usage #6701

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7b03f8d
codes: update docstring to indicate expected usage
dfawley Oct 6, 2023
9b61d75
fix comments
dfawley Oct 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion codes/codes.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,13 @@ import (
"strconv"
)

// 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
Copy link
Contributor

@zasweq zasweq Oct 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Member Author

@dfawley dfawley Oct 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

//
// Only the codes defined as consts in this package are valid codes. Do not use
// other code values. Behavior and interopability are implementation-specific
// and not guaranteed.
Copy link
Contributor

@zasweq zasweq Oct 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Member Author

@dfawley dfawley Oct 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clarified.

type Code uint32

const (
Expand Down