Skip to content

Name isEnabled() in the README's "Turning it off" - #31

Merged
dmccoystephenson merged 1 commit into
mainfrom
feature/readme-isenabled
Nov 8, 2026
Merged

dmccoystephenson merged 1 commit into
mainfrom
feature/readme-isenabled

Conversation

@dmccoystephenson

Copy link
Copy Markdown
Member

Summary

  • One sentence pair is added to the README's "Turning it off" section naming client.isEnabled() (whether report will send anything) and stating how it differs from disabledReason() after close(): isEnabled() turns false while disabledReason() is unchanged (still empty for a client that was reporting).
  • The behavior was verified against trace_client.hpp (isEnabled() returns current(), documented "False after close()"; disabledReason() documented "Unchanged by close()") and against closeIsPromptAndIdempotent in test/test_trace_client.cpp, which asserts both.

Closes #30

Deferred issues

Test plan

  • README-only change; no source, test, Makefile or CMake file touched (local anchor UNVERIFIED-not-applicable).
  • CI Build green on the PR head.

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

The README documented disabledReason(), environmentOptsOut() and
installId() but never isEnabled(), and did not say the two status
methods part ways after close().

Closes #30

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@dmccoystephenson

Copy link
Copy Markdown
Member Author

Self-review rubric (anchored on CI run 42447424649, all 11 jobs green):

  • Scope: PASS — only README.md is modified, three added lines in "Turning it off", all for README never mentions isEnabled() #30.
  • Tests-new: PASS (n/a) — no new public method; documentation only.
  • Tests-fix: PASS (n/a) — not a bug fix; no production code changed.
  • Sibling structure: PASS — no new file.
  • Sibling renames: PASS — no identifiers renamed.
  • Docs: PASS — the new text matches trace_client.hpp:1058-1065 ("False after close()" on isEnabled(), "Unchanged by close()" on disabledReason()) and the assertions in closeIsPromptAndIdempotent (CHECK(!client.isEnabled()), CHECK(client.disabledReason().empty())). Header comment and version untouched.
  • Issue resolution: PASS — README never mentions isEnabled() #30 asked for one sentence in "Turning it off" naming isEnabled() and its post-close() behavior; both are present.
  • CI: PASS — linux (g++/clang++ × c++11/17/20), linux-libcurl, linux-sanitizers (thread; address,undefined), macos, windows all green on the head SHA.
  • Registered / C++11 / No new dependency / Never throws / Curl argv fixed / Version triple / Sanitizers: PASS (n/a) — no header, test, Makefile or CMake change.

Local anchor: UNVERIFIED-not-applicable (README-only diff); CI on the head SHA serves as the anchor.

Do-not-auto-merge path check: README.md only — no protected path matched.

This review was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).


drafted by Claude on behalf of Daniel Stephenson

@dmccoystephenson
dmccoystephenson merged commit 9e4c81e into main Nov 8, 2026
11 checks passed
@dmccoystephenson
dmccoystephenson deleted the feature/readme-isenabled branch November 8, 2026 04:36
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.

README never mentions isEnabled()

1 participant