Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Events in README #106

Closed
wants to merge 78 commits into from
Closed

docs: Events in README #106

wants to merge 78 commits into from

Conversation

fabriziodemaria
Copy link
Member

@fabriziodemaria fabriziodemaria commented Mar 25, 2024

WAIT ON RELEASE: #88

@fabriziodemaria fabriziodemaria changed the title Events in README docs: Events in README Mar 25, 2024
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
fabriziodemaria and others added 3 commits March 25, 2024 11:49
Co-authored-by: Nicklas Lundin <[email protected]>
Co-authored-by: Nicklas Lundin <[email protected]>
Co-authored-by: Nicklas Lundin <[email protected]>
README.md Outdated
final Confidence confidenceWithContext = confidence.withContext(ConfidenceValue.of("context-value"));
confidenceWithContext.send("my-event", ConfidenceValue.of("event-value"));
```
The "my-event" event in the example above will contain fields for "event-value", "context-value" and the Evaluation Context data set via `OpenFeatureAPI.getInstance().setEvaluationContext(...)`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit:

Suggested change
The "my-event" event in the example above will contain fields for "event-value", "context-value" and the Evaluation Context data set via `OpenFeatureAPI.getInstance().setEvaluationContext(...)`.
The "my-event" event in the example above will contain fields for "event-value", "context-value" and the Evaluation Context data set via `OpenFeatureAPI.getInstance().setEvaluationContext(...)`.
We suggest you you this `withContext()`-API to send events which are "request context" based events as well.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We suggest you you this withContext()-API to send events which are "request context" based events as well.

Can you re-phrase slightly or explain here what you mean?

@vahidlazio vahidlazio changed the base branch from evnt-generic to main March 25, 2024 12:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants