Skip to content

Commit 16bc52a

Browse files
committed
fix: typos and wording
Signed-off-by: Chris Laprun <claprun@redhat.com>
1 parent 9f27ac9 commit 16bc52a

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

docs/content/en/docs/documentation/reconciler.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -182,10 +182,11 @@ require the latest status version possible, for example, if the status subresour
182182
See [Representing Allocated Values](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#representing-allocated-values)
183183
from the Kubernetes docs for more details.
184184

185-
The framework provides utilities to help with these use cases:
186-
[`PrimaryUpdateAndCacheUtils`](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/PrimaryUpdateAndCacheUtils.java).
185+
The framework provides the
186+
[`PrimaryUpdateAndCacheUtils`](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/PrimaryUpdateAndCacheUtils.java) utility class
187+
to help with these use cases.
187188

188-
Framework you can use internal caches in combination with update methods that use
189+
This class' methods use internal caches in combination with update methods that leveraging
189190
optimistic locking. If the update method fails on optimistic locking, it will retry
190191
using a fresh resource from the server as base for modification.
191192

@@ -206,10 +207,11 @@ public UpdateControl<StatusPatchCacheCustomResource> reconcile(
206207
}
207208
```
208209

209-
After the update `PrimaryUpdateAndCacheUtils.ssaPatchStatusAndCacheResource` puts the response of the update into an internal
210-
cache and the framework will make sure that the next reconciliation will contain the most recent version of the resource.
211-
Note that it is not necessarily the version of the resource you got as response from the update, it can be newer since other parties
212-
can do additional updates meanwhile. However, if not explicitly modified, it will contain the up-to-date resource.
210+
After the update `PrimaryUpdateAndCacheUtils.ssaPatchStatusAndCacheResourceWithLock` puts the result of the update into an internal
211+
cache and the framework will make sure that the next reconciliation contains the most recent version of the resource.
212+
Note that it is not necessarily the same version returned as response from the update, it can be a newer version since other parties
213+
can do additional updates meanwhile. However, unless it has been explicitly modified, that
214+
resource will contain the up-to-date status.
213215

214-
See related integration test [here](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/statuscache).
215216

217+
See related integration test [here](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/statuscache).

0 commit comments

Comments
 (0)