docs: sweep minor documentation and comment drift (audit #16) - #256
Merged
Conversation
|
|
xytan0056
approved these changes
Jul 30, 2026
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
sbalabanov
force-pushed
the
audit/fix-16-doc-drift-sweep
branch
from
August 3, 2026 22:23
439b845 to
890913e
Compare
sbalabanov
marked this pull request as ready for review
August 3, 2026 22:24
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
Documentation and comments had drifted from the actual code in several places, causing confusion for readers who trust the docs as ground truth.
Changes
ErrorCode.String()default description; add the missingFieldsexport to the API index; renameErrDownloadBazeliskNetworktoErrNetwork; align theclassifyBazelClientErrorfallthrough withNewInfra; and fix the protostringspelling.Configcollaborator and per-repository config provider.//example/cmd/query-bench.versionto.PHONY.The metrics naming comment originally included in this PR is no longer part of the diff because latest
mainalready contains a more precise version of that correction.Test Plan
make gazelle(no generated changes)./tools/bazel test //... --test_output=errors --test_env=GIT_CONFIG_COUNT=1 --test_env=GIT_CONFIG_KEY_0=commit.gpgSign --test_env=GIT_CONFIG_VALUE_0=falseRevert Plan
Revert commit
890913e0d52b7c2ccd2afc0c5ff754abfbda2306.