docs: correct stale comment on retained_response_retirement_enabled flag - #1589
Open
detail-app[bot] wants to merge 1 commit into
Open
detail-app[bot] wants to merge 1 commit into
detail-app[bot] wants to merge 1 commit into
Conversation
Deploying control-layer with
|
| Latest commit: |
502789d
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://b8155f25.control-layer.pages.dev |
| Branch Preview URL: | https://detail-fix-docs-docs-correct.control-layer.pages.dev |
This branch has not been deployed
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
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.
The README comment marked retained_response_retirement_enabled as
"Reserved; true is rejected until retirement ships," but the retirement
implementation shipped in the same commit (the daemon's
run_retained_response_retirement_loop is spawned when the flag is on, and
config validation accepts true with a valid batchless retention policy).
The stale annotation would mislead an operator into believing daily
response retirement isn't implemented and prevent them from enabling it.
For example, an operator reading the config block would leave the flag
disabled, assuming it's gated behind an unfinished feature, and miss the
scheduled partition-drop retirement of aged response objects.
Introduced by commit fc5aeae (@pjb157, #1481)
Doc Drift PRs can be configured here.