Skip to content

Commit c8d8718

Browse files
authored
Moved documentation comments to base_client file and made changes to GlideClient for pkgsite to work (valkey-io#2981)
* moved docs from interfaces to base client Signed-off-by: Edward Liang <[email protected]>
1 parent 0651d7b commit c8d8718

17 files changed

+3206
-2859
lines changed

go/api/base_client.go

Lines changed: 3058 additions & 15 deletions
Large diffs are not rendered by default.

go/api/connection_management_commands.go

Lines changed: 0 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -8,47 +8,9 @@ package api
88
//
99
// [valkey.io]: https://valkey.io/commands/#connection
1010
type ConnectionManagementCommands interface {
11-
// Pings the server.
12-
//
13-
// Return value:
14-
// Returns "PONG".
15-
//
16-
// For example:
17-
// result, err := client.Ping()
18-
//
19-
// [valkey.io]: https://valkey.io/commands/ping/
2011
Ping() (string, error)
2112

22-
// Pings the server with a custom message.
23-
//
24-
// Parameters:
25-
// message - A message to include in the `PING` command.
26-
//
27-
// Return value:
28-
// Returns the copy of message.
29-
//
30-
// For example:
31-
// result, err := client.PingWithMessage("Hello")
32-
//
33-
// [valkey.io]: https://valkey.io/commands/ping/
3413
PingWithMessage(message string) (string, error)
3514

36-
// Echo the provided message back.
37-
// The command will be routed a random node.
38-
//
39-
// Parameters:
40-
// message - The provided message.
41-
//
42-
// Return value:
43-
// The provided message
44-
//
45-
// For example:
46-
// result, err := client.Echo("Hello World")
47-
// if err != nil {
48-
// // handle error
49-
// }
50-
// fmt.Println(result.Value()) // Output: Hello World
51-
//
52-
// [valkey.io]: https://valkey.io/commands/echo/
5315
Echo(message string) (Result[string], error)
5416
}

0 commit comments

Comments
 (0)