Skip to content

Commit f014806

Browse files
authored
docs: fix typos (#310)
Signed-off-by: Sahid Velji <[email protected]>
1 parent edf0deb commit f014806

File tree

6 files changed

+20
-20
lines changed

6 files changed

+20
-20
lines changed

specification.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
{
6060
"id": "Requirement 1.1.6",
6161
"machine_id": "requirement_1_1_6",
62-
"content": "The `API` MUST provide a function for creating a `client` which accepts the following options: - domain (optional): A logical string identifier for binding clients to provider.",
62+
"content": "The `API` MUST provide a function for creating a `client` which accepts the following options: - domain (optional): A logical string identifier for binding a client to a provider.",
6363
"RFC 2119 keyword": "MUST",
6464
"children": []
6565
},
@@ -539,7 +539,7 @@
539539
{
540540
"id": "Requirement 3.1.4",
541541
"machine_id": "requirement_3_1_4",
542-
"content": "The evaluation context fields MUST have an unique key.",
542+
"content": "The evaluation context fields MUST have a unique key.",
543543
"RFC 2119 keyword": "MUST",
544544
"children": []
545545
},
@@ -991,7 +991,7 @@
991991
{
992992
"id": "Requirement 5.2.4",
993993
"machine_id": "requirement_5_2_4",
994-
"content": "The `handler function` MUST accept a `event details` parameter.",
994+
"content": "The `handler function` MUST accept an `event details` parameter.",
995995
"RFC 2119 keyword": "MUST",
996996
"children": []
997997
},

specification/glossary.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ The possible states and transitions of a provider over the course of its usage,
123123

124124
### Domain
125125

126-
An identifier which logically binds clients with providers, allowing for multiple providers to be used simultaneously within a single application. Domain binding is dynamic; it may change over the course of an application's lifetime (ie: a client associated to the default provider via an unbound domain will be bound to a new provider if a provider is subsequently assigned to that domain).
126+
An identifier which logically binds clients with providers, allowing for multiple providers to be used simultaneously within a single application. Domain binding is dynamic; it may change over the course of an application's lifetime (i.e.: a client associated with the default provider via an unbound domain will be bound to a new provider if a provider is subsequently assigned to that domain).
127127

128128
### Integration
129129

@@ -139,15 +139,15 @@ An SDK-compliant implementation that stores and returns transaction-specific eva
139139

140140
### Evaluating Flag Values
141141

142-
The process of retrieving a feature flag value in it's entirety, including:
142+
The process of retrieving a feature flag value in its entirety, including:
143143

144144
- any effects resulting from hooks
145145
- resolving a flag value from a configured provider
146146
- falling back to a supplied default, in the case of abnormal execution
147147

148148
### Resolving Flag Values
149149

150-
The process of a provider retrieving a feature flag value from it's particular source-of-truth.
150+
The process of a provider retrieving a feature flag value from its particular source-of-truth.
151151

152152
### Tracking Event
153153

specification/sections/01-flag-evaluation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ See [provider](./02-providers.md), [creating clients](#creating-clients) for det
4242
4343
Application authors can await the newly set `provider's` readiness using the `PROVIDER_READY` event.
4444
Provider instances which are already active (because they have been bound to another `domain` or otherwise) need not be initialized again.
45-
The `provider's` readiness can state can be determined from its `status` member/accessor.
45+
The `provider's` readiness state can be determined from its `status` member/accessor.
4646

4747
See [event handlers and initialization](./05-events.md#event-handlers-and-initialization), [provider initialization](./02-providers.md#24-initialization), [domain](../glossary.md#domain) for details.
4848

@@ -109,7 +109,7 @@ OpenFeature.getProviderMetadata();
109109
```
110110

111111
It's possible to access provider metadata using a `domain`.
112-
If a provider has not be registered under the requested domain, the default provider metadata is returned.
112+
If a provider has not been registered under the requested domain, the default provider metadata is returned.
113113

114114
```typescript
115115
// example provider accessor
@@ -124,15 +124,15 @@ See [provider](./02-providers.md), [domain](../glossary.md#domain) for details.
124124

125125
> The `API` **MUST** provide a function for creating a `client` which accepts the following options:
126126
>
127-
> - domain (optional): A logical string identifier for binding clients to provider.
127+
> - domain (optional): A logical string identifier for binding a client to a provider.
128128
129129
```java
130130
// example client creation and retrieval
131131
OpenFeature.getClient();
132132
```
133133

134134
It's possible to create a client that is associated with a `domain`.
135-
The client will use a provider in the same `domain` if one exists, otherwise, the default provide is used.
135+
The client will use a provider in the same `domain` if one exists, otherwise, the default provider is used.
136136

137137
```java
138138
// example client creation and retrieval using a domain

specification/sections/03-evaluation-context.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ see: [structure](../types.md#structure), [datetime](../types.md#datetime)
3939
4040
#### Requirement 3.1.4
4141

42-
> The evaluation context fields **MUST** have an unique key.
42+
> The evaluation context fields **MUST** have a unique key.
4343
4444
The key uniquely identifies a field in the `evaluation context` and it should be unique across all types to avoid any collision when marshalling the `evaluation context` by the provider.
4545

@@ -126,7 +126,7 @@ see: [static-context paradigm](../glossary.md#static-context-paradigm)
126126

127127
> When the global `evaluation context` is set, the `on context changed` function **MUST** run.
128128
129-
The SDK implementation must run the `on context changed` function on all registered provider that use the global `evaluation context` whenever it is mutated.
129+
The SDK implementation must run the `on context changed` function on all registered providers that use the global `evaluation context` whenever it is mutated.
130130

131131
##### Conditional Requirement 3.2.4.2
132132

specification/sections/05-events.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ graph
2323
```
2424

2525
The `domain` of a provider constitutes a logical scope for events.
26-
Clients associated to a particular provider through a `domain`, run event handlers only when that provider emits events, or one of its lifecycle functions terminates.
26+
Clients associated with a particular provider through a `domain` run event handlers only when that provider emits events, or one of its lifecycle functions terminates.
2727

2828
see: [domain](../glossary.md#domain)
2929

@@ -33,7 +33,7 @@ see: [domain](../glossary.md#domain)
3333

3434
> The `provider` **MAY** define a mechanism for signaling the occurrence of one of a set of events, including `PROVIDER_READY`, `PROVIDER_ERROR`, `PROVIDER_CONFIGURATION_CHANGED` and `PROVIDER_STALE`, with a `provider event details` payload.
3535
36-
Providers cannot emit `PROVIDER_CONTEXT_CHANGED` or `PROVIDER_RECONCILING` event.
36+
Providers cannot emit `PROVIDER_CONTEXT_CHANGED` or `PROVIDER_RECONCILING` events.
3737
These are emitted only by the SDK during context reconciliation.
3838

3939
If available, native event-emitter or observable/observer language constructs can be used.
@@ -112,7 +112,7 @@ See [setting a provider](./01-flag-evaluation.md#setting-a-provider), [creating
112112

113113
#### Requirement 5.2.4
114114

115-
> The `handler function` **MUST** accept a `event details` parameter.
115+
> The `handler function` **MUST** accept an `event details` parameter.
116116
117117
see: [`event details`](../types.md#event-details)
118118

@@ -164,7 +164,7 @@ See [provider initialization](./02-providers.md#24-initialization) and [setting
164164
165165
Handlers may be attached at any point in the application lifecycle.
166166
Handlers should run immediately if the provider is already in the associated state.
167-
For instance, _application authors_ may attach readiness handlers to be confident that system is ready to evaluate flags.
167+
For instance, _application authors_ may attach readiness handlers to be confident that the system is ready to evaluate flags.
168168
If such handlers are attached after the provider underlying the client has already been initialized, they should run immediately.
169169

170170
See [provider initialization](./02-providers.md#24-initialization), [setting a provider](./01-flag-evaluation.md#setting-a-provider).
@@ -233,7 +233,7 @@ see: [provider event types](../types.md#provider-events), [provider events](#51-
233233
> If the provider emits an event, the value of the client's `provider status` **MUST** be updated accordingly.
234234
235235
Some providers may emit events spontaneously, based on changes in their internal state (connections, caches, etc).
236-
The SDK must update it's internal representation of the provider's state accordingly:
236+
The SDK must update its internal representation of the provider's state accordingly:
237237

238238
| Event | Associated Status |
239239
| -------------------------------- | ------------------------------------------------------- |
@@ -246,4 +246,4 @@ The SDK must update it's internal representation of the provider's state accordi
246246

247247
\* If the `error code` associated with the error indicates `PROVIDER_FATAL`, the state is set to `FATAL`
248248

249-
see: [provider lifecycle management](01-flag-evaluation.md#17-provider-lifecycle-management), [provider status](../types.md#provider-status) [error codes](../types.md#error-code)
249+
see: [provider lifecycle management](01-flag-evaluation.md#17-provider-lifecycle-management), [provider status](../types.md#provider-status) [error codes](../types.md#error-code)

specification/types.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ A structure representing the result of the [flag evaluation process](./glossary.
4444

4545
> [!NOTE]
4646
> Some type systems feature useful constraints that can enhance the ergonomics of the `evaluation details` structure.
47-
> For example, in the case of an unsuccessful evaluation, `error code`, `reason`, and `error message` will be set, and variant will not.
47+
> For example, in the case of an unsuccessful evaluation, `error code`, `reason`, and `error message` will be set, and `variant` will not.
4848
> If the type system of the implementation supports the expression of such constraints, consider defining them.
4949
5050
### Resolution Details
@@ -68,7 +68,7 @@ A set of pre-defined reasons is enumerated below:
6868
| DEFAULT | The resolved value fell back to a pre-configured value (no dynamic evaluation occurred or dynamic evaluation yielded no result). |
6969
| TARGETING_MATCH | The resolved value was the result of a dynamic evaluation, such as a rule or specific user-targeting. |
7070
| SPLIT | The resolved value was the result of pseudorandom assignment. |
71-
| CACHED | The resolved value was retrieved from cache. |
71+
| CACHED | The resolved value was retrieved from a cache. |
7272
| DISABLED | The resolved value was the result of the flag being disabled in the management system. |
7373
| UNKNOWN | The reason for the resolved value could not be determined. |
7474
| STALE | The resolved value is non-authoritative or possibly out of date |

0 commit comments

Comments
 (0)