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

doc: add detail to confmap watcher #12150

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

mattsains
Copy link
Contributor

Description

I tried to improve the docs on watchers based on the issue below

Link to tracking issue

Fixes #12115

Documentation

Clarified some code comments that were incorrect (there's no Retrieved.Get method) and included a new code sample for a Provider that uses the watcher func

@mattsains mattsains requested review from mx-psi, evan-bradley and a team as code owners January 22, 2025 00:08
@mattsains mattsains force-pushed the watcher-docs branch 2 times, most recently from ba832d9 to f833595 Compare January 22, 2025 00:10
@mattsains
Copy link
Contributor Author

I can write a CHANGELOG entry for this, but I don't think it's helpful. Let me know if I should anyway to get the CI to pass

Copy link

codecov bot commented Jan 22, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.76%. Comparing base (b09a65b) to head (818d609).
Report is 20 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #12150      +/-   ##
==========================================
+ Coverage   91.73%   91.76%   +0.03%     
==========================================
  Files         463      463              
  Lines       24819    24809      -10     
==========================================
- Hits        22767    22766       -1     
+ Misses       1670     1659      -11     
- Partials      382      384       +2     

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

@mx-psi mx-psi added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Jan 22, 2025
confmap/README.md Outdated Show resolved Hide resolved
confmap/provider_test.go Show resolved Hide resolved
confmap/provider_test.go Show resolved Hide resolved
@mx-psi
Copy link
Member

mx-psi commented Jan 23, 2025

@bogdandrutu Could you double check this since you designed this in the first place?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation and example for confmap/Provider interface which actually has a callback mechanism
3 participants