Skip to content

Commit 2cf4fb0

Browse files
committed
docs: update provider requirement 2.4.1
Signed-off-by: Max VelDink <[email protected]>
1 parent 16aae06 commit 2cf4fb0

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

specification/sections/02-providers.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ ResolutionDetails<MyStruct> resolveStructureValue(string flagKey, MyStruct defau
121121
```
122122
##### Requirement 2.2.9
123123

124-
> The `provider` **SHOULD** populate the `resolution details` structure's `flag metadata` field.
124+
> The `provider` **SHOULD** populate the `resolution details` structure's `flag metadata` field.
125125
126126
##### Requirement 2.2.10
127127

@@ -164,12 +164,11 @@ class MyProvider implements Provider {
164164

165165
#### Requirement 2.4.1
166166

167-
> The `provider` **MAY** define an `initialize` function which accepts the global `evaluation context` as an argument and performs initialization logic relevant to the provider.
167+
> The `provider` **MAY** define an initialization function which accepts the global `evaluation context` as an argument and performs initialization logic relevant to the provider.
168168
169169
Many feature flag frameworks or SDKs require some initialization before they can be used.
170170
They might require the completion of an HTTP request, establishing persistent connections, or starting timers or worker threads.
171-
The `initialize` function is an ideal place for such logic.
172-
The `initialize` function is named in accordance with language idioms.
171+
The initialization function is an ideal place for such logic.
173172

174173
```java
175174
// MyProvider implementation of the initialize function defined in Provider
@@ -282,7 +281,7 @@ class MyProvider implements Provider {
282281
//...
283282
284283
onContextChanged(EvaluationContext oldContext, EvaluationContext newContext): void {
285-
// update context-sensitive cached flags, or otherwise react to the change in the global context
284+
// update context-sensitive cached flags, or otherwise react to the change in the global context
286285
}
287286
288287
//...
@@ -291,4 +290,4 @@ class MyProvider implements Provider {
291290
292291
Providers may maintain remote connections, timers, threads or other constructs that need to be appropriately disposed of.
293292
Provider authors may implement a `shutdown` function to perform relevant clean-up actions.
294-
Alternatively, implementations might leverage language idioms such as auto-disposable interfaces or some means of cancellation signal propagation to allow for graceful shutdown.
293+
Alternatively, implementations might leverage language idioms such as auto-disposable interfaces or some means of cancellation signal propagation to allow for graceful shutdown.

0 commit comments

Comments
 (0)