doc: update client and rpc usage examples

graugans · Apr 14, 2024 · e863743 · e863743
1 parent 984d049
commit e863743
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/pkg/ovp8xx/client.go b/pkg/ovp8xx/client.go
@@ -25,7 +25,7 @@ type (
 // multiple client options.
 // Example usage:
 //
-//	client := NewClient(WithTimeout(10 * time.Second), WithRetry(3))
+//	client := NewClient(WithHost("192.168.47.11"))
 //	// ...
 func NewClient(opts ...ClientOption) *Client {
 	// Initialise with default values

diff --git a/pkg/ovp8xx/rpc.go b/pkg/ovp8xx/rpc.go
@@ -20,7 +20,10 @@ func IsTimeoutError(err error) bool {
 // Get retrieves the configuration for the specified pointers from the OVP8xx device.
 // The pointers parameter is a slice of strings that contains the pointers to retrieve the configuration for.
 // The function returns the retrieved configuration as a Config struct and an error if any occurred.
-// Example usage: config, err := device.Get([]string{"/device", "/ports"})
+// Example usage:
+//
+//	config, err := device.Get([]string{"/device", "/ports"})
+//	// ...
 func (device *Client) Get(pointers []string) (Config, error) {
 	client, err := xmlrpc.NewClient(device.url)
 	if err != nil {