fix(docs): correct env backend watch mode support #517
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The env backend does not support watch mode - it only reads environment variables at startup or during interval-based polling. Update README.md to accurately reflect this: - Remove 'env' from watch mode feature list - Change env backend table row to show ❌ for watch mode This aligns with the env backend README which explicitly states: "Watch mode is not supported for the env backend." Fixes #514
There was a problem hiding this comment.
Pull request overview
This PR corrects documentation that incorrectly indicated the env backend supports watch mode, aligning it with the actual backend capabilities documented in pkg/backends/env/README.md.
Changes:
- Removed
envfrom the list of backends supporting watch mode in the features section - Updated the env backend table entry to show ❌ for watch mode support
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #517 +/- ##
==========================================
+ Coverage 62.30% 62.36% +0.05%
==========================================
Files 48 48
Lines 5420 5420
==========================================
+ Hits 3377 3380 +3
+ Misses 1834 1831 -3
Partials 209 209 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Fix documentation that incorrectly marks the env backend as supporting watch mode.
Changes
envfrom the watch mode feature list (line 21)Before
After
Reference
From
pkg/backends/env/README.md:127:Fixes #514
🤖 Generated with Claude Code