-
Notifications
You must be signed in to change notification settings - Fork 4.4k
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.
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
advancedtls: fix docstring for VerificationResults #7168
Conversation
5d09a28
to
3f9f427
Compare
@@ -67,6 +67,9 @@ type VerificationFuncParams = HandshakeVerificationInfo | |||
// future to include more information. | |||
type PostHandshakeVerificationResults struct{} | |||
|
|||
// VerificationResults contains the information about results of | |||
// CustomVerificationFunc. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is this moved to new line by auto formatter?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think so, it was the same earlier:
grpc-go/security/advancedtls/advancedtls.go
Lines 57 to 59 in 5fe2e74
// VerificationResults contains the information about results of | |
// CustomVerificationFunc. | |
// VerificationResults is an empty struct for now. It may be extended in the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So what's the fix here, how come tests are passed now?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm. Thanks for quick fix!
3f9f427
to
ff5b041
Compare
ff5b041
to
1596874
Compare
I think this fix is also part of this PR https://github.com/grpc/grpc-go/pull/7151/files |
I see. @gtcooke94, will #7151 be merged soon? If not, should we fix only the lint error to make the tests healthy again? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No worries just merging this as-is, I'll deal with any git weirdness on #7151 on my own
@dfawley PTAL and merge if it looks good. I can't merge since I don't have write access. |
The static checks enabled in #7155 are failing due #7140 being merged around the same time. #7140 removed the doc string for VerificationResults and replaced it with a deprecation note. As a result the static check failed with the following error:
Example failure: https://github.com/grpc/grpc-go/actions/runs/8811877128/job/24186556563?pr=7163
This change brings back the first line of the doc string to satisfy the test.
RELEASE NOTES: none