Repository navigation
Bring three Javadocs up to the fail-closed opt-outs - #52
Merged
Merged
Conversation
0.8.0 made every switch fail closed, but three comments still describe the old lists of values that turn reporting off: the ENV_USAGE_REPORTING and ENV_DO_NOT_TRACK constants, Builder.serverWideConfig, and ServerWideConfig.NONE (an unreadable file is now UNREADABLE, not NONE). They now say what disabledReason(Builder) and parseServerWideConfig do. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Member
Author
|
Self-review rubric (anchored on CI run 44689832145 for the PR head):
Judgment call noted: the new The comment-only change is accurate and in scope, and none of the do-not-auto-merge paths are touched. This review was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener). drafted by Claude on behalf of Daniel Stephenson |
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
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
Stage A documentation accuracy sweep. Every documentation source of truth was checked against the code: the README tables, the class Javadoc, the method Javadoc,
pom.xmlandbuild.yml. The only drift found is three comments inTraceClient.javathat were not updated when #51 made every opt-out fail closed (0.8.0):ENV_USAGE_REPORTING/ENV_DO_NOT_TRACK: these listed only the values that turn reporting off (off, false, 0, noand1, true, yes). Under 0.8.0, any non-blank value outside the "keep reporting" set turns reporting off (environmentSaysOff). The Javadoc now says that, in the same words as the class Javadoc and the README "Opting out" table.Builder.serverWideConfig: this said the file "honoursenabled: false(oroff,0,no)".parseServerWideConfignow disables on anyenabled:value other thantrue/on/yes/1, andreadServerWideConfigreturnsUNREADABLE(disabled) for a file that is there but cannot be read. Both are now stated.ServerWideConfig.NONE: the comment said it covers a file that "could not be read". Since 0.8.0 that case isUNREADABLE.NONEcovers: no file asked for, the environment opted out first, or a missing file that could not be created or whose path could not be represented.Only comments change. The behaviour, wire format,
REASON_*/ENV_*values, and README are untouched. The README was checked and already matches the code.Open issues not picked this cycle
MAX_TAGShandling ofversionandcoalesced). Each issue lists options for the maintainer, so both are human decisions and were deferred.Test plan
mvn -B verifylocally: 123 tests run, 0 failures (comment-only change)build (8),build (17),build (21)greenNo tracking issue: the gap was found during the triage docs sweep.
This PR description was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).
🤖 Generated with Claude Code
drafted by Claude on behalf of Daniel Stephenson