Add instructions on using NewClient in its Godoc docblock
#6
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
brandur
force-pushed
the
brandur-client-example
branch
from
96ee725 to
76fddf9
Compare
bgentry
approved these changes
Nov 11, 2023
There's an example at the top of the River package demonstrating the use of `NewClient`, but as I was reading the docs today, I realized that since `NewClient` is somewhat non-trivial to invoke because it requires a generic parameter, it'd be a good idea to also have an example of its use right in `NewClient`'s docblock. That way, if a user is viewing this function they don't need to go hunt around for examples to try and figure out how to use it.
brandur
force-pushed
the
brandur-client-example
branch
from
76fddf9 to
eaedfca
Compare
|
Thx! |
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.
There's an example at the top of the River package demonstrating the use
of
NewClient, but as I was reading the docs today, I realized thatsince
NewClientis somewhat non-trivial to invoke because it requiresa generic parameter, it'd be a good idea to also have an example of its
use right in
NewClient's docblock. That way, if a user is viewing thisfunction they don't need to go hunt around for examples to try and
figure out how to use it.