chore(client): collapse verify_compliance_receipt + BudgetTracker docstrings - #200
Merged
Conversation
…strings `verify_compliance_receipt` had a 23-sentence, 2062-char docstring with a `spec Section 2.1` citation (rule-3 forbidden) and a multi-paragraph narrative of every MUST. Collapsed to the rule-10 budget (2 sentences). `BudgetTracker` class docstring had a 9-sentence prose preamble before the Example block. Collapsed to 2 sentences; Example preserved. Docstring-only diff; zero behaviour change. comment hygiene clean
3 tasks
jagmarques
added a commit
that referenced
this pull request
May 23, 2026
CLAUDE.md rule 10 caps docstrings at 1-2 sentences. Cycle 18 deep slop hunt found numerous multi-sentence docstrings across asqav-sdk Python source that overran. This PR collapses them in place across 19 files. Excludes files in open PRs (client.py #200, extras/* #196 and #198, cli.py). Doc / comment only; zero behaviour change. Tests pass (747/747). comment hygiene clean
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
1 participant
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
Collapses two egregious multi-sentence docstrings in `python/src/asqav/client.py` to the CLAUDE.md rule-10 budget. Docstring-only diff; zero behaviour change.
Why
Cycle 18 deep slop hunt (`~/.company/cycles/c18/scans/SLOP-DEEP.md`) flagged `client.py` as the heaviest pattern-B offender in the SDK. The two worst:
Both are now 2-sentence summaries; per-arg detail in the verify helper is recoverable from the function signature and the structured `ComplianceReceiptVerification` return type.
Test plan
comment hygiene clean