Skip to content

Commit eb292e5

Browse files
authored
Merge pull request #1818 from sgreene570/fix-option-godocs
✨ manager.go: Fix a few Options fields' go-docs
2 parents d887b2f + 364ed9a commit eb292e5

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

pkg/manager/manager.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -98,9 +98,9 @@ type Manager interface {
9898

9999
// Options are the arguments for creating a new Manager.
100100
type Options struct {
101-
// Scheme is the scheme used to resolve runtime.Objects to GroupVersionKinds / Resources
101+
// Scheme is the scheme used to resolve runtime.Objects to GroupVersionKinds / Resources.
102102
// Defaults to the kubernetes/client-go scheme.Scheme, but it's almost always better
103-
// idea to pass your own scheme in. See the documentation in pkg/scheme for more information.
103+
// to pass your own scheme in. See the documentation in pkg/scheme for more information.
104104
Scheme *runtime.Scheme
105105

106106
// MapperProvider provides the rest mapper used to map go types to Kubernetes APIs
@@ -186,11 +186,11 @@ type Options struct {
186186
// between tries of actions. Default is 2 seconds.
187187
RetryPeriod *time.Duration
188188

189-
// Namespace if specified restricts the manager's cache to watch objects in
190-
// the desired namespace Defaults to all namespaces
189+
// Namespace, if specified, restricts the manager's cache to watch objects in
190+
// the desired namespace. Defaults to all namespaces.
191191
//
192192
// Note: If a namespace is specified, controllers can still Watch for a
193-
// cluster-scoped resource (e.g Node). For namespaced resources the cache
193+
// cluster-scoped resource (e.g Node). For namespaced resources, the cache
194194
// will only hold objects from the desired namespace.
195195
Namespace string
196196

@@ -228,7 +228,7 @@ type Options struct {
228228
// if this is set, the Manager will use this server instead.
229229
WebhookServer *webhook.Server
230230

231-
// Functions to all for a user to customize the values that will be injected.
231+
// Functions to allow for a user to customize values that will be injected.
232232

233233
// NewCache is the function that will create the cache to be used
234234
// by the manager. If not set this will use the default new cache function.

0 commit comments

Comments
 (0)