Improve doc comments for client constructors #19293
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
jhendrixMSFT
requested review from
JeffreyRichter,
richardpark-msft and
siminsavani-msft
ghost
added
the
richardpark-msft
approved these changes
Oct 5, 2022
| @@ -33,6 +33,8 @@ type BlobClientOptions struct { | |||
| } | |||
|
|
|||
| // NewBlobClient creates a blob lease client for the provided blob client. | |||
| // - client - an instance of a blob client | |||
| // - options - client options; pass nil to accept the default values | |||
| func NewBlobClient[T appendblob.Client | blob.Client | blockblob.Client | pageblob.Client](client *T, options *BlobClientOptions) (*BlobClient, error) { | |||
There was a problem hiding this comment.
Cool use of generics/constraints. for code hygiene, I recommend changing the order of the constraints:
blob.Client | blockblob.Client | appendblob.Client | pageblob.Client
There was a problem hiding this comment.
Ordering them from commonly used to least commonly used?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 #19274