docs(init): use console-script form in package docstring examples#34
Merged
Merged
Conversation
Closes #31. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
cmeans
reviewed
Apr 22, 2026
Owner
cmeans
left a comment
There was a problem hiding this comment.
QA Review — PR #34
Verdict: QA Failed
One substantive finding blocks signoff (missing CHANGELOG entry). Everything else I checked passed.
Verification
python -m yt_dont_recommend --versionstill fails withNo module named yt_dont_recommend.__main__— confirms issue #31's premise and confirms PR chose option 1 (docstring fix) rather than option 2 (add__main__.py). Correct choice per issue discussion.- Rendered docstring verified via
python -c "import yt_dont_recommend; print(yt_dont_recommend.__doc__)"— every Usage: example now usesyt-dont-recommend …with--blocklistwhere required, License line readsApache-2.0. - Bare
yt-dont-recommendprints help — matches the PR claim that--blocklistor--clickbaitis now required to do work.--check-selectorsand--loginstand alone without--blocklist; also correct. - No remaining
python -m yt_dont_recommendreferences anywhere in the repo (grep -rn "python -m yt_dont_recommend" --include="*.py" --include="*.md" --include="*.yaml" --include="*.yml" --include="*.toml"returns zero hits). - License docstring correction (MIT → Apache-2.0) matches
pyproject.toml(license = {text = "Apache-2.0"}) and LICENSE file. Legitimate cleanup of stale metadata; the scope-creep callout in the PR body is fair. - Tests:
.venv/bin/python -m pytest tests/ -q→ 449 passed (34.13s). Matches PR body. - CI: all required checks green on
docs/init-docstring-console-script.
Findings
| # | Finding | Severity |
|---|---|---|
| 1 | No CHANGELOG.md ## [Unreleased] entry for this PR. Project convention is that every PR — docs-only included — adds an Unreleased entry. The existing ### Changed — License changed from MIT to Apache-2.0 entry describes the PR #22 license switch itself, not this PR's catch-up of stale docstring metadata, and there is no entry for the console-script example cleanup or closes #31. Suggested: add a ### Fixed entry, e.g. "Corrected stale python -m yt_dont_recommend examples and License: MIT metadata in the package module docstring to match the console-script entry point and the Apache-2.0 license switch (closes #31)." |
substantive |
| 2 | CLAUDE.md:79 and CLAUDE.md:90 still reference a pre-restructure invocation .venv/bin/python yt_dont_recommend.py --source /tmp/test-blocklist.txt. There is no top-level yt_dont_recommend.py — running that command errors the same way the old docstring examples did. Strictly out of scope for issue #31 (which targeted src/yt_dont_recommend/__init__.py only), but it's the same doc-drift failure mode and the PR already took one scope-creep (license line). Either tighten up in this PR or file a follow-up. |
observation |
Unchecked PR checkbox
The PR body's second test-plan checkbox (QA: spot-check the rendered docstring via python -c "import yt_dont_recommend; print(yt_dont_recommend.__doc__)" and confirm every Usage: example is invokable as written) is now verified by QA. I'll tick it as part of the review.
Addresses QA feedback on #34: - Add `### Fixed` entry under `[Unreleased]` for this PR. - Fix `CLAUDE.md:79` and `CLAUDE.md:90` which still reference the pre-restructure `.venv/bin/python yt_dont_recommend.py` invocation (no such top-level script exists). Same doc-drift pattern as the `python -m` examples in the package docstring. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
cmeans
reviewed
Apr 22, 2026
Owner
cmeans
left a comment
There was a problem hiding this comment.
QA Review — Round 2 on PR #34
Verdict: Ready for QA Signoff
Both findings from round 1 addressed; re-verification clean.
Re-verification
- CHANGELOG
## [Unreleased] → ### Fixedentry added (424688b) — closes #31, describes the docstring fix, theCLAUDE.mdconsole-script catch-up, and theLicense: MIT → Apache-2.0docstring correction all in one entry. Correct section, correct category. CLAUDE.md:79,90now use.venv/bin/yt-dont-recommend --blocklist --source /tmp/test-blocklist.txt— matches the console-script form and preserves the CLI semantics (--blocklistrequired,--sourceconsumed, empty file still triggerscheck_removals()for the Step 5 unblock cycle).- Rendered docstring still correct — re-ran
python -c "import yt_dont_recommend; print(yt_dont_recommend.__doc__)"; every Usage: example is invokable, License readsApache-2.0. - Repo-wide scan:
grep -rn "python -m yt_dont_recommend\|python yt_dont_recommend\.py\|python3 yt_dont_recommend\.py"→ only hit is the CHANGELOG entry itself (quoting the old pattern in prose). No remaining live usages. - Tests:
.venv/bin/python -m pytest tests/ -q→ 449 passed in 34.06s. - Lint:
.venv/bin/ruff check src/ tests/→ all checks passed. - CI green on the refreshed branch; mergeable.
Promoting to Ready for QA Signoff. Maintainer can apply QA Approved.
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
Closes #31.
Test plan