Skip to content

Commit 1cf87bc

Browse files
Eric Stroczynskihasbro17
Eric Stroczynski
andauthored
Apply suggestions from code review
Co-Authored-By: Haseeb Tariq <[email protected]>
1 parent 71b9de5 commit 1cf87bc

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

doc/user/client.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ func (r *ReconcileApp) Reconcile(request reconcile.Request) (reconcile.Result, e
137137
func (c Client) List(ctx context.Context, list runtime.Object, opts ...client.ListOption) error
138138
```
139139

140-
A `client.ListOption` is an interface that sets [`client.ListOptions`][list-options] fields. A `client.ListOption` is created by using one of the provided implementations: [`MatchingLabels`][matchinglabels], [`MatchingFields`][matchingfields], [`InNamespace`][innamespace].
140+
A `client.ListOption` is an interface that sets [`client.ListOptions`][list-options] fields. A `client.ListOption` is created by using one of the provided implementations: [`MatchingLabels`][matching-labels], [`MatchingFields`][matching-fields], [`InNamespace`][in-namespace].
141141

142142
Example:
143143

@@ -181,7 +181,7 @@ func (r *ReconcileApp) Reconcile(request reconcile.Request) (reconcile.Result, e
181181
func (c Client) Create(ctx context.Context, obj runtime.Object, opts ...client.CreateOption) error
182182
```
183183

184-
A `client.CreateOption` is an interface that sets [`client.CreateOptions`][create-options] fields. A `client.CreateOption` is created by using one of the provided implementations: [`DryRunAll`][dryrunall], [`ForceOwnership`][forceownership]. Generally these options are not needed.
184+
A `client.CreateOption` is an interface that sets [`client.CreateOptions`][create-options] fields. A `client.CreateOption` is created by using one of the provided implementations: [`DryRunAll`][dry-run-all], [`ForceOwnership`][force-ownership]. Generally these options are not needed.
185185

186186
Example:
187187

@@ -262,6 +262,7 @@ Example:
262262
import (
263263
"context"
264264
"k8s.io/api/apps/v1"
265+
"sigs.k8s.io/controller-runtime/pkg/client"
265266
"sigs.k8s.io/controller-runtime/pkg/reconcile"
266267
)
267268

@@ -332,7 +333,7 @@ func (r *ReconcileApp) Reconcile(request reconcile.Request) (reconcile.Result, e
332333
}
333334
```
334335

335-
[statuswriter]:https://godoc.org/sigs.k8s.io/controller-runtime/pkg/client#StatusWriter
336+
[status-writer]:https://godoc.org/sigs.k8s.io/controller-runtime/pkg/client#StatusWriter
336337

337338
#### Delete
338339

@@ -377,11 +378,11 @@ func (r *ReconcileApp) Reconcile(request reconcile.Request) (reconcile.Result, e
377378
[preconditions]:https://godoc.org/sigs.k8s.io/controller-runtime/pkg/client#Preconditions
378379
[propagationpolicy]:https://godoc.org/sigs.k8s.io/controller-runtime/pkg/client#PropagationPolicy
379380

380-
#### Delete
381+
#### DeleteAllOf
381382

382383
```Go
383384
// DeleteAllOf deletes all objects of the given type matching the given options.
384-
func (c Client) Delete(ctx context.Context, obj runtime.Object, opts ...client.DeleteAllOfOption) error
385+
func (c Client) DeleteAllOf(ctx context.Context, obj runtime.Object, opts ...client.DeleteAllOfOption) error
385386
```
386387

387388
A `client.DeleteAllOfOption` is an interface that sets [`client.DeleteAllOfOptions`][deleteallof-opts] fields. A `client.DeleteAllOfOption` wraps a [`client.ListOption`](#list) and [`client.DeleteOption`](#delete).

0 commit comments

Comments
 (0)