README: correct three claims that drifted from the code - #2
dmccoystephenson wants to merge 2 commits into
Conversation
- A blank report name is ignored without a Logger mention; the promise table said every drop reaches the Logger. - Under Emscripten the reason is "unavailable" only when no earlier opt-out (environment, config, no key) applied. - The MSVC instructions built Debug but pointed at build/Release; add --config Release, as CI does. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
Self-review rubric (head
Repo-specific items:
Finding fixed during review: the Emscripten edit left one line far wider than the rest of the wrapped paragraph. It was rewrapped in Judgment call left for the reviewer: README.md:32 ("Never throws") still says "Drops are passed to the optional No do-not-auto-merge paths are touched. The PR is left open for human review and merge, because this dispatch is not authorized to merge. This review was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener). drafted by Claude on behalf of Daniel Stephenson |
Summary
A Stage A documentation sweep was run. Every claim in
README.mdwas checked againsttrace_client.hpp,Makefile,CMakeLists.txtand.github/workflows/build.yml. Three README claims were found that no longer matched the code, and they are corrected here. No code was changed.enqueuereturns early on a blank name (trace_client.hpp:900) and nothing is logged. The promise table said drops are passed to theLogger. The "Fits the server's limits" row now says a blank-named report is ignored without aLoggermention. This behaviour is already covered byreportIgnoresABlankName.trace_client.hpp:790-797), so"unavailable"is the reason under Emscripten only when none of those opt-outs applies first. The README said it was always"unavailable".cmake --build buildbuilds the Debug configuration with multi-config generators, but the README pointed atbuild/Release/test_trace_client.--config Releasewas added, which matches thewindowsCI job.Not changed here
TRACE_CLIENT_CURLoverrides the curl executable. On Windows,findCurlprefersSystem32\curl.exeregardless of that macro, so the override has no effect there. Whether the code or the docs should change is the owner's call, so it is tracked in TRACE_CLIENT_CURL override is ignored on Windows when System32\curl.exe exists #1 rather than decided in a docs PR.disabledReason()strings, the curl command line andprotoline, the wire-format headers, theUser-Agentversion (the same 0.1.0 in all three places), the Makefile targets, and the CI matrix description.Test plan
git diff --stat origin/main: 1 file). No anchor-relevant files (trace_client.hpp,test/,Makefile,CMakeLists.txt) were touched, so the localmake testanchor is recorded as UNVERIFIED-not-applicable.Buildis green on the PR head.No tracking issue: this is a gap found during triage (Stage A sweep).
This PR description was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).
drafted by Claude on behalf of Daniel Stephenson