Skip to content

docs: use context.TODO() in README examples #378

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

Merged
merged 1 commit into from
Jun 3, 2025

Conversation

sahidvelji
Copy link
Contributor

@sahidvelji sahidvelji commented Jun 3, 2025

This PR

By convention, it is a good idea to use context.TODO() in examples instead of context.Background() in example code to indicate to the reader that these should be updated.

Related Issues

Notes

https://pkg.go.dev/context#TODO

Follow-up Tasks

How to test

Signed-off-by: Sahid Velji <sahidvelji@gmail.com>
Copy link

codecov bot commented Jun 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.69%. Comparing base (b169115) to head (f1c69f1).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #378   +/-   ##
=======================================
  Coverage   85.69%   85.69%           
=======================================
  Files          20       20           
  Lines        1447     1447           
=======================================
  Hits         1240     1240           
  Misses        186      186           
  Partials       21       21           
Flag Coverage Δ
e2e 85.69% <ø> (ø)
unit 85.69% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@sahidvelji sahidvelji marked this pull request as ready for review June 3, 2025 13:32
@sahidvelji sahidvelji requested review from a team as code owners June 3, 2025 13:32
Copy link
Member

@beeme1mr beeme1mr left a comment

Choose a reason for hiding this comment

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

Make sense, thanks

@beeme1mr beeme1mr merged commit 2f39d23 into open-feature:main Jun 3, 2025
7 checks passed
@sahidvelji sahidvelji deleted the context-docs branch June 3, 2025 13:48
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.

2 participants