1. docker
  2. Commit 44e1ccd0a3e96d7e6a0e01f2b0c8078578f869bc
Browse code

client: add missing doc comments to config, secret, and node types

Add missing Go doc comments to the exported option and result types
in config_remove.go, config_update.go, secret_remove.go,
secret_update.go, node_inspect.go, node_list.go, node_remove.go,
and node_update.go.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Poyraz Küçükarslan <83272398+PoyrazK@users.noreply.github.com>

Poyraz Küçükarslan authored on 2026/03/06 03:02:31
Showing 16 changed files
client/config_remove.go
History View file @ 44e1ccd
... ... 
@@ -2,10 +2,12 @@ package client
2 2
3 3 
 import "context"
4 4
5 
+// ConfigRemoveOptions holds options for [Client.ConfigRemove].
5 6 
 type ConfigRemoveOptions struct {
6 7 
 	// Add future optional parameters here
7 8 
 }
8 9
10 
+// ConfigRemoveResult holds the result of [Client.ConfigRemove].
9 11 
 type ConfigRemoveResult struct {
10 12 
 	// Add future fields here
11 13 
 }
client/config_update.go
History View file @ 44e1ccd
... ... 
@@ -13,6 +13,7 @@ type ConfigUpdateOptions struct {
13 13 
 	Spec    swarm.ConfigSpec
14 14 
 }
15 15
16 
+// ConfigUpdateResult holds the result of [Client.ConfigUpdate].
16 17 
 type ConfigUpdateResult struct{}
17 18
18 19 
 // ConfigUpdate attempts to update a config
client/node_inspect.go
History View file @ 44e1ccd
... ... 
@@ -12,6 +12,7 @@ import (
12 12 
 // NodeInspectOptions holds parameters to inspect nodes with.
13 13 
 type NodeInspectOptions struct{}
14 14
15 
+// NodeInspectResult holds the result of [Client.NodeInspect].
15 16 
 type NodeInspectResult struct {
16 17 
 	Node swarm.Node
17 18 
 	Raw  json.RawMessage
client/node_list.go
History View file @ 44e1ccd
... ... 
@@ -13,6 +13,7 @@ type NodeListOptions struct {
13 13 
 	Filters Filters
14 14 
 }
15 15
16 
+// NodeListResult holds the result of [Client.NodeList].
16 17 
 type NodeListResult struct {
17 18 
 	Items []swarm.Node
18 19 
 }
client/node_remove.go
History View file @ 44e1ccd
... ... 
@@ -9,6 +9,8 @@ import (
9 9 
 type NodeRemoveOptions struct {
10 10 
 	Force bool
11 11 
 }
12 
+
13 
+// NodeRemoveResult holds the result of [Client.NodeRemove].
12 14 
 type NodeRemoveResult struct{}
13 15
14 16 
 // NodeRemove removes a Node.
client/node_update.go
History View file @ 44e1ccd
... ... 
@@ -13,6 +13,7 @@ type NodeUpdateOptions struct {
13 13 
 	Spec    swarm.NodeSpec
14 14 
 }
15 15
16 
+// NodeUpdateResult holds the result of [Client.NodeUpdate].
16 17 
 type NodeUpdateResult struct{}
17 18
18 19 
 // NodeUpdate updates a Node.
client/secret_remove.go
History View file @ 44e1ccd
... ... 
@@ -2,10 +2,12 @@ package client
2 2
3 3 
 import "context"
4 4
5 
+// SecretRemoveOptions holds options for [Client.SecretRemove].
5 6 
 type SecretRemoveOptions struct {
6 7 
 	// Add future optional parameters here
7 8 
 }
8 9
10 
+// SecretRemoveResult holds the result of [Client.SecretRemove].
9 11 
 type SecretRemoveResult struct {
10 12 
 	// Add future fields here
11 13 
 }
client/secret_update.go
History View file @ 44e1ccd
... ... 
@@ -13,6 +13,7 @@ type SecretUpdateOptions struct {
13 13 
 	Spec    swarm.SecretSpec
14 14 
 }
15 15
16 
+// SecretUpdateResult holds the result of [Client.SecretUpdate].
16 17 
 type SecretUpdateResult struct{}
17 18
18 19 
 // SecretUpdate attempts to update a secret.
vendor/github.com/moby/moby/client/config_remove.go
History View file @ 44e1ccd
... ... 
@@ -2,10 +2,12 @@ package client
2 2
3 3 
 import "context"
4 4
5 
+// ConfigRemoveOptions holds options for [Client.ConfigRemove].
5 6 
 type ConfigRemoveOptions struct {
6 7 
 	// Add future optional parameters here
7 8 
 }
8 9
10 
+// ConfigRemoveResult holds the result of [Client.ConfigRemove].
9 11 
 type ConfigRemoveResult struct {
10 12 
 	// Add future fields here
11 13 
 }
vendor/github.com/moby/moby/client/config_update.go
History View file @ 44e1ccd
... ... 
@@ -13,6 +13,7 @@ type ConfigUpdateOptions struct {
13 13 
 	Spec    swarm.ConfigSpec
14 14 
 }
15 15
16 
+// ConfigUpdateResult holds the result of [Client.ConfigUpdate].
16 17 
 type ConfigUpdateResult struct{}
17 18
18 19 
 // ConfigUpdate attempts to update a config
vendor/github.com/moby/moby/client/node_inspect.go
History View file @ 44e1ccd
... ... 
@@ -12,6 +12,7 @@ import (
12 12 
 // NodeInspectOptions holds parameters to inspect nodes with.
13 13 
 type NodeInspectOptions struct{}
14 14
15 
+// NodeInspectResult holds the result of [Client.NodeInspect].
15 16 
 type NodeInspectResult struct {
16 17 
 	Node swarm.Node
17 18 
 	Raw  json.RawMessage
vendor/github.com/moby/moby/client/node_list.go
History View file @ 44e1ccd
... ... 
@@ -13,6 +13,7 @@ type NodeListOptions struct {
13 13 
 	Filters Filters
14 14 
 }
15 15
16 
+// NodeListResult holds the result of [Client.NodeList].
16 17 
 type NodeListResult struct {
17 18 
 	Items []swarm.Node
18 19 
 }
vendor/github.com/moby/moby/client/node_remove.go
History View file @ 44e1ccd
... ... 
@@ -9,6 +9,8 @@ import (
9 9 
 type NodeRemoveOptions struct {
10 10 
 	Force bool
11 11 
 }
12 
+
13 
+// NodeRemoveResult holds the result of [Client.NodeRemove].
12 14 
 type NodeRemoveResult struct{}
13 15
14 16 
 // NodeRemove removes a Node.
vendor/github.com/moby/moby/client/node_update.go
History View file @ 44e1ccd
... ... 
@@ -13,6 +13,7 @@ type NodeUpdateOptions struct {
13 13 
 	Spec    swarm.NodeSpec
14 14 
 }
15 15
16 
+// NodeUpdateResult holds the result of [Client.NodeUpdate].
16 17 
 type NodeUpdateResult struct{}
17 18
18 19 
 // NodeUpdate updates a Node.
vendor/github.com/moby/moby/client/secret_remove.go
History View file @ 44e1ccd
... ... 
@@ -2,10 +2,12 @@ package client
2 2
3 3 
 import "context"
4 4
5 
+// SecretRemoveOptions holds options for [Client.SecretRemove].
5 6 
 type SecretRemoveOptions struct {
6 7 
 	// Add future optional parameters here
7 8 
 }
8 9
10 
+// SecretRemoveResult holds the result of [Client.SecretRemove].
9 11 
 type SecretRemoveResult struct {
10 12 
 	// Add future fields here
11 13 
 }
vendor/github.com/moby/moby/client/secret_update.go
History View file @ 44e1ccd
... ... 
@@ -13,6 +13,7 @@ type SecretUpdateOptions struct {
13 13 
 	Spec    swarm.SecretSpec
14 14 
 }
15 15
16 
+// SecretUpdateResult holds the result of [Client.SecretUpdate].
16 17 
 type SecretUpdateResult struct{}
17 18
18 19 
 // SecretUpdate attempts to update a secret.