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]>
Bit-Quill · Jan 24, 2025 · c8d8718 · c8d8718
1 parent 0651d7b
commit c8d8718
Show file tree

Hide file tree

Showing 17 changed files with 3,206 additions and 2,859 deletions.
diff --git a/go/api/base_client.go b/go/api/base_client.go
diff --git a/go/api/connection_management_commands.go b/go/api/connection_management_commands.go
@@ -8,47 +8,9 @@ package api
 //
 // [valkey.io]: https://valkey.io/commands/#connection
 type ConnectionManagementCommands interface {
-	// Pings the server.
-	//
-	// Return value:
-	//  Returns "PONG".
-	//
-	// For example:
-	//  result, err := client.Ping()
-	//
-	// [valkey.io]: https://valkey.io/commands/ping/
 	Ping() (string, error)
 
-	// Pings the server with a custom message.
-	//
-	// Parameters:
-	//  message - A message to include in the `PING` command.
-	//
-	// Return value:
-	//  Returns the copy of message.
-	//
-	// For example:
-	//  result, err := client.PingWithMessage("Hello")
-	//
-	// [valkey.io]: https://valkey.io/commands/ping/
 	PingWithMessage(message string) (string, error)
 
-	// Echo the provided message back.
-	// The command will be routed a random node.
-	//
-	// Parameters:
-	// 	message - The provided message.
-	//
-	// Return value:
-	//  The provided message
-	//
-	// For example:
-	//  result, err := client.Echo("Hello World")
-	//	if err != nil {
-	//	    // handle error
-	//	}
-	//	fmt.Println(result.Value()) // Output: Hello World
-	//
-	// [valkey.io]: https://valkey.io/commands/echo/
 	Echo(message string) (Result[string], error)
 }