Skip to content

docs: sweep minor documentation and comment drift (audit #16) - #256

Merged
sbalabanov merged 1 commit into
mainfrom
audit/fix-16-doc-drift-sweep
Aug 3, 2026
Merged

docs: sweep minor documentation and comment drift (audit #16)#256
sbalabanov merged 1 commit into
mainfrom
audit/fix-16-doc-drift-sweep

Conversation

@sbalabanov

@sbalabanov sbalabanov commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

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

  • docs/errors/errors.md: fix the ErrorCode.String() default description; add the missing Fields export to the API index; rename ErrDownloadBazeliskNetwork to ErrNetwork; align the classifyBazelClientError fallthrough with NewInfra; and fix the proto string spelling.
  • controller/README.md: remove false claims about a Config collaborator and per-repository config provider.
  • README.md: remove the stale "and services" wording and replace nonexistent generated interfaces in the mockgen example.
  • example/cmd/query-bench/main.go: fix the Bazel label to //example/cmd/query-bench.
  • Makefile: add version to .PHONY.

The metrics naming comment originally included in this PR is no longer part of the diff because latest main already 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=false

Revert Plan

Revert commit 890913e0d52b7c2ccd2afc0c5ff754abfbda2306.

@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@sbalabanov
sbalabanov force-pushed the audit/fix-16-doc-drift-sweep branch from 439b845 to 890913e Compare August 3, 2026 22:23
@sbalabanov
sbalabanov marked this pull request as ready for review August 3, 2026 22:24
@sbalabanov
sbalabanov requested review from a team as code owners August 3, 2026 22:24
@sbalabanov
sbalabanov merged commit bc43c0a into main Aug 3, 2026
16 of 17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants