Skip to content
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

Moved documentation comments to base_client file and made changes to GlideClient for pkgsite to work #2981

Open
wants to merge 23 commits into
base: main
Choose a base branch
from

Conversation

edlng
Copy link
Contributor

@edlng edlng commented Jan 20, 2025

Issue link

This Pull Request is linked to issue (URL):

Checklist

Before submitting the PR make sure the following are checked:

  • This Pull Request is related to one issue.
  • Commit message has a detailed description of what changed and why.
  • Tests are added or updated.
  • CHANGELOG.md and documentation files are updated.
  • Destination branch is correct - main or release
  • Create merge commit if merging release branch into main, squash otherwise.

@edlng edlng requested a review from a team as a code owner January 20, 2025 21:18
edlng and others added 18 commits January 20, 2025 14:49
* GO: add xpending command

Signed-off-by: jbrinkman <[email protected]>
Signed-off-by: Edward Liang <[email protected]>
* GO Implement Dump and ObjectEncoding command

Signed-off-by: EdricCua <[email protected]>
Signed-off-by: Edward Liang <[email protected]>
* Implement Echo Command

Signed-off-by: EdricCua <[email protected]>
Signed-off-by: Edward Liang <[email protected]>
* Go: `XREADGROUP`.

Signed-off-by: Yury-Fridlyand <[email protected]>
Signed-off-by: Edward Liang <[email protected]>
* Shadow protobuf

Signed-off-by: Yury-Fridlyand <[email protected]>
Signed-off-by: Edward Liang <[email protected]>
* Go: `XAUTOCLAIM`.

Signed-off-by: Yury-Fridlyand <[email protected]>
Signed-off-by: Edward Liang <[email protected]>
…-io#2956)

* Go: update return types & response handlers for scan commands

Signed-off-by: TJ Zhang <[email protected]>
Signed-off-by: Edward Liang <[email protected]>
…-io#2958)

* Implement Object Freq, Idle and RefCount

Signed-off-by: EdricCua <[email protected]>
Signed-off-by: Edward Liang <[email protected]>
…2888)

* Sort,Sort_RO,Sort Store commands

Signed-off-by: Niharika Bhavaraju <[email protected]>
Signed-off-by: Edward Liang <[email protected]>
* Go: `XGROUP CREATE`.

Signed-off-by: Yury-Fridlyand <[email protected]>
Signed-off-by: Edward Liang <[email protected]>
…y-io#2975)

* go xGroupCreateConsumer and XGroupDelConsumer

Signed-off-by: jbrinkman <[email protected]>

Co-authored-by: Yury-Fridlyand <[email protected]>
Signed-off-by: Edward Liang <[email protected]>
* Fix return types.

Signed-off-by: Yury-Fridlyand <[email protected]>
Signed-off-by: Edward Liang <[email protected]>
Fix return types

Signed-off-by: Yury-Fridlyand <[email protected]>
Signed-off-by: Edward Liang <[email protected]>
Signed-off-by: Edward Liang <[email protected]>
Signed-off-by: Edward Liang <[email protected]>
go/api/base_client.go Outdated Show resolved Hide resolved
go/api/base_client.go Show resolved Hide resolved
go/api/base_client.go Show resolved Hide resolved
go/api/base_client.go Show resolved Hide resolved
go/api/base_client.go Outdated Show resolved Hide resolved
go/api/base_client.go Outdated Show resolved Hide resolved
go/api/base_client.go Outdated Show resolved Hide resolved
go/api/base_client.go Outdated Show resolved Hide resolved
go/api/base_client.go Outdated Show resolved Hide resolved
go/api/base_client.go Outdated Show resolved Hide resolved
@Yury-Fridlyand Yury-Fridlyand mentioned this pull request Jan 21, 2025
6 tasks
@Yury-Fridlyand Yury-Fridlyand added go golang wrapper docs Documentation labels Jan 22, 2025
// GlideClient is a client used for connection in Standalone mode.
type GlideClient interface {
// IGlideClient is a client used for connection in Standalone mode.
type IGlideClient interface {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rename symbol IGlideClient to GlideClientCommands to better align the interface name to what it actually represents - an aggregation of all of the command interfaces.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

@@ -7,30 +7,57 @@ package api
import "C"

// GlideClusterClient interface compliance check.
var _ GlideClusterClient = (*glideClusterClient)(nil)
var _ IGlideClusterClient = (*GlideClusterClient)(nil)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rename symbol IGlideClusterClient to GlideClusterClientCommands to better align the interface name to what it actually represents - an aggregation of all of the command interfaces.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

// If key exists, returns the value of key as a Result[string]. Otherwise, return [api.CreateNilStringResult()].
//
// For example:
// 1. key: value
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indentation should be consistent for the entire file for documentation.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On GitHub you can set for the appearance of tabs to be 4 spaces instead (for some reason the default is 8 ) and that "fixes" the appearance issue. All good

edlng added 2 commits January 22, 2025 13:41
Signed-off-by: Edward Liang <[email protected]>
@edlng edlng closed this Jan 22, 2025
@edlng edlng reopened this Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation go golang wrapper
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants