From e6f485cee66dd92d02ca4a9fb0849f358c36331f Mon Sep 17 00:00:00 2001 From: Todd Baert Date: Tue, 6 Feb 2024 12:40:09 -0500 Subject: [PATCH] fix: language-neutral verbiage fix Signed-off-by: Todd Baert --- specification.json | 2 +- specification/sections/01-flag-evaluation.md | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/specification.json b/specification.json index fcb882e7..14e4cf6d 100644 --- a/specification.json +++ b/specification.json @@ -31,7 +31,7 @@ { "id": "Requirement 1.1.2.4", "machine_id": "requirement_1_1_2_4", - "content": "The `API` SHOULD provide functions to set a provider and wait for the `initialize` function to return or throw.", + "content": "The `API` SHOULD provide functions to set a provider and wait for the `initialize` function to complete or abnormally terminate.", "RFC 2119 keyword": "SHOULD", "children": [] }, diff --git a/specification/sections/01-flag-evaluation.md b/specification/sections/01-flag-evaluation.md index b1b47c3e..78baa293 100644 --- a/specification/sections/01-flag-evaluation.md +++ b/specification/sections/01-flag-evaluation.md @@ -57,7 +57,7 @@ see [shutdown](./02-providers.md#25-shutdown), [setting a provider](#setting-a-p #### Requirement 1.1.2.4 -> The `API` **SHOULD** provide functions to set a provider and wait for the `initialize` function to return or throw. +> The `API` **SHOULD** provide functions to set a provider and wait for the `initialize` function to complete or abnormally terminate. This function not only sets the provider, but ensures that the provider is ready (or in error) before returning or settling. @@ -74,6 +74,7 @@ Client client = OpenFeatureAPI.getInstance().getClient('domain-1'); ``` Though it's possible to use [events](./05-events.md) to await provider readiness, such functions can make things simpler for `application authors` and `integrators`. +Implementations indicate an error in a manner idiomatic to the language in use (returning an error, throwing and exception, etc). #### Requirement 1.1.3