Go: Add command zlexcount #3140
Conversation
tjzhang-BQ
had a problem deploying
to
AWS_ACTIONS
GitHub Actions
Error
| @@ -526,3 +526,23 @@ func ExampleGlideClient_ZUnionWithScores() { | |||
| // Output: | |||
| // map[one:1 three:3 two:5.5] | |||
| } | |||
|
|
|||
| func ExampleGlideClient_ZLexCount() { | |||
There was a problem hiding this comment.
Also add an example for ExampleGlideClusterClient_ZLexCount()
There was a problem hiding this comment.
added, although is it necessary that we make separate examples for single key commands like this one? it's same code with the same results
There was a problem hiding this comment.
Yes. Examples in Go are keyed to documentation by the func name. So ExampleGlideClient_ZLexCount will show in the documentation for the GlideClient type. The ExampleGlideClusterClient_ZLexCount will show in the documentation for the GlideClusterClient type. This ensures that regardless of which environment you are in you will see the correct documentation, with examples. You and I know the examples are the same, but an end user does not know that, and there are a couple instances where that is not the case (e.g. CustomCommand)
tjzhang-BQ
had a problem deploying
to
AWS_ACTIONS
GitHub Actions
Error
tjzhang-BQ
had a problem deploying
to
AWS_ACTIONS
GitHub Actions
Error
| @@ -526,3 +526,23 @@ func ExampleGlideClient_ZUnionWithScores() { | |||
| // Output: | |||
| // map[one:1 three:3 two:5.5] | |||
| } | |||
|
|
|||
| func ExampleGlideClient_ZLexCount() { | |||
There was a problem hiding this comment.
Yes. Examples in Go are keyed to documentation by the func name. So ExampleGlideClient_ZLexCount will show in the documentation for the GlideClient type. The ExampleGlideClusterClient_ZLexCount will show in the documentation for the GlideClusterClient type. This ensures that regardless of which environment you are in you will see the correct documentation, with examples. You and I know the examples are the same, but an end user does not know that, and there are a couple instances where that is not the case (e.g. CustomCommand)
| @@ -526,3 +526,43 @@ func ExampleGlideClient_ZUnionWithScores() { | |||
| // Output: | |||
| // map[one:1 three:3 two:5.5] | |||
| } | |||
|
|
|||
| func ExampleGlideClient_ZLexCount() { | |||
There was a problem hiding this comment.
Consider adding multiple examples. The integration tests offer a couple examples with simple setup that can be easily refactored into examples. The goal is to make it easy on the developer so they don't have to download source code and dig around in our test files just to figure out how to use the client.
Signed-off-by: TJ Zhang <tj.zhang@improving.com>
Signed-off-by: TJ Zhang <tj.zhang@improving.com>
tjzhang-BQ
force-pushed
the
go/tjz-zlexcount
branch
from
04060d8 to
2e4d204
Compare
tjzhang-BQ
had a problem deploying
to
AWS_ACTIONS
GitHub Actions
Error
tjzhang-BQ
requested a deployment
to
AWS_ACTIONS
GitHub Actions
Waiting
Issue link
This Pull Request is linked to issue (URL): #2972
Checklist
Before submitting the PR make sure the following are checked: