credentials: Update doc strings for NewClientTLSFromCert et. al. #3508
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
dfawley
approved these changes
Apr 8, 2020
credentials/tls.go
Outdated
| // NewClientTLSFromCert constructs TLS credentials from the input certificate for client. | ||
| // NewClientTLSFromCert constructs TLS credentials from the provided root | ||
| // certificate authority certificate(s) to validate server connections. If | ||
| // certificates to establish the identity of the client need to included in the |
credentials/tls.go
Outdated
| // NewClientTLSFromFile constructs TLS credentials from the input certificate file for client. | ||
| // NewClientTLSFromFile constructs TLS credentials from the provided root | ||
| // certificate authority certificate file(s) to validate server connections. If | ||
| // certificates to establish the identity of the client need to included in the |
Capstan
reviewed
Apr 9, 2020
| func NewClientTLSFromCert(cp *x509.CertPool, serverNameOverride string) TransportCredentials { | ||
| return NewTLS(&tls.Config{ServerName: serverNameOverride, RootCAs: cp}) | ||
| } | ||
|
|
||
| // NewClientTLSFromFile constructs TLS credentials from the input certificate file for client. | ||
| // NewClientTLSFromFile constructs TLS credentials from the provided root | ||
| // certificate authority certificate file(s) to validate server connections. If |
There was a problem hiding this comment.
nit: AFAICT, this is a single file, though it may contain more than one certificate, so the "(s)" should still belong to "certificate"
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.
Fixes #3507