Skip to content

[DOC] Clarify the behavior of SetProviderAsync #445

@beeme1mr

Description

@beeme1mr

Change in the documentation

The SetProviderAsync behaves differently than nearly every other method in OpenFeature because it can throw if the underlying provider throws during its initiation. This was a conscious design choice documented in the spec (requirement 1.4.10). However, it's not obvious in our examples that an error can be returned while setting a provider.

Requirements

  • Ensure that the XML Doc comments for the SetProviderAsync method clearly defines the behavior.
  • Update the examples in the readme to use a try/catch when using SetProviderAsync.

Metadata

Metadata

Assignees

No one assigned

    Labels

    type: docsImprovements or additions to documentation

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions