Skip to content

docs(help-wanted): #182 solved the next-uses-bare-name kit, but the docs still counted it as open - #202

Merged
joyful-ii-V-I merged 3 commits into
mainfrom
docs/help-wanted-solved-kit
Sep 12, 2026
Merged

joyful-ii-V-I merged 3 commits into
mainfrom
docs/help-wanted-solved-kit

Conversation

@joyful-ii-V-I

Copy link
Copy Markdown
Collaborator

@antoleod's #182 fixed the problem the next-uses-bare-name starter kit describes, and with it #158. The docs still count that kit as open:

  • prompts/help-wanted/README.md lists it among the open problems.
  • README.md says "twenty open problems", "twenty kits — pick one" and "all twenty prompts", and shows "(three)" beside the good-first-issue label.

Change

  • prompts/help-wanted/README.md: the kit's row moves to a new Solved table at the end of the file. The table names Fix declined next-pointer callers #182, its author and the issue it closed.
  • prompts/help-wanted/next-uses-bare-name.md: the kit stays, as a worked example of one that landed. A note at the top says the paths, lines and outputs below describe the tree before the fix.
  • README.md: the four counts are reworded without a number: "open problems", "pick one", "all the prompts", and the label link on its own. Each count was kept by hand and went stale every time a kit was solved, and getting kits solved is the point of the folder.

No generated document and no gate pins these counts.

Also: the reference guide's --scip sentence

Section 7 of the reference guide (#192) says "A missing index causes a refusal." Since #197, a --scip path that is empty or is not a regular file (a directory, a FIFO or a device) is refused the same way, with exit 1. The sentence now says so, in the guide's own style. It matches the README's escalation list, which #197 already updated.

Verification

On the merged tree: the 27 README gates plus showcasecapturecheck, gates=28 pass=28 skip=0 fail=0. docs/limits_build.py --check and docs/gatecount_build.py --check exit 0.

Closes #158.

🤖 Generated with Claude Code

joyful-ii-V-I and others added 3 commits September 12, 2026 09:50
…ocs still counted it as open

@antoleod's #182 fixed the problem the next-uses-bare-name starter kit describes. prompts/help-wanted/README.md still
listed it as open, and README.md said "twenty open problems", "twenty kits", "all twenty prompts" and "(three)" good
first issues. Each of those counts is kept by hand and goes stale whenever a kit is solved.

- prompts/help-wanted/README.md: the kit's row moves to a new Solved table at the end, which names #182, its author
  and the issue it closed (#158).
- prompts/help-wanted/next-uses-bare-name.md: kept as a worked example of a kit that landed. A note at the top says
  the paths, lines and outputs below describe the tree before the fix.
- README.md: the four counts are reworded without a number.

No generated document and no gate pins these counts.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
…fuses

Section 7 of the reference guide said "A missing index causes a refusal." Since #197 a --scip path that is
empty, or is not a regular file (a directory, a FIFO, a device), is refused the same way (exit 1). The
sentence now says so, in the guide's own one-instruction-per-sentence style, matching the escalation list
#197 already updated.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Sep 12, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: 5e4ca222-b5db-4891-8dcb-48b83184b7d2

📥 Commits

Reviewing files that changed from the base of the PR and between 0d1544d and 3a1efca.

📒 Files selected for processing (3)
  • README.md
  • prompts/help-wanted/README.md
  • prompts/help-wanted/next-uses-bare-name.md

Included review availability: Your plan provides up to 4 included reviews per hour; 2 remain after this review.


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated contribution guidance to link directly to all available prompts without citing a fixed number of open problems.
    • Marked the “next uses bare name” prompt as solved while retaining it as a worked example.
    • Clarified SCIP index guidance: missing, empty, or invalid paths are rejected, while corrupt indexes continue to trigger a warning and fallback behavior.

Walkthrough

The README updates contribution links and SCIP input validation guidance. The help-wanted documentation moves next-uses-bare-name from open problems to solved prompts and preserves it as a historical worked example.

Changes

Documentation and guidance

Layer / File(s) Summary
SCIP input validation guidance
README.md
The README now states that missing, empty, or non-regular SCIP paths cause refusal with exit 1. Corrupt indexes still trigger a warning and name-based fallback.
Contribution links and solved prompt status
README.md, prompts/help-wanted/README.md, prompts/help-wanted/next-uses-bare-name.md
Contribution guidance no longer uses fixed item counts. The bare-name prompt is removed from open problems, listed as solved, and marked as a historical worked example.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 3a1ef

The documentation updates are consistent and do not introduce a merge-blocking behavior change.

🚥 Pre-merge checks | ✅ 6 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Out of Scope Changes check ⚠️ Warning The solved-kit documentation, solved table entry, and stale open-problem count are within #158's scope. The README change that documents refusal of empty or non-regular --scip paths is unrelated to … Remove the unrelated --scip documentation change from this PR, or link it to a separate issue and submit it separately.
✅ Passed checks (6 passed)
Check name Status Explanation
Description check ✅ Passed The description clearly explains the solved kit, stale counts, SCIP guidance, and verification results.
Linked Issues check ✅ Passed The changes directly address issue #158 and document its resolution by PR #182. The references to #192 and #197 support the SCIP documentation update.
Out of Scope Changes check ✅ Passed All changes concern help-wanted documentation, stale counts, and related SCIP guidance. No unrelated changes are present.
Title check ✅ Passed The title clearly identifies the main change: documenting that the next-uses-bare-name kit was solved while removing its stale open-problem status.
Linked Issues check ✅ Passed The linked coding requirement in #158 is satisfied at the reviewed head. src/callhierarchy.h derives a bare-name selector when declinedCalls > 0 and the caller selector is narrowed. It preserves t…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Full details: Out of Scope Changes check

Explanation

The solved-kit documentation, solved table entry, and stale open-problem count are within #158's scope. The README change that documents refusal of empty or non-regular --scip paths is unrelated to #158. The linked issue concerns callers next= pointers for declined calls.

  • Fix all pre-merge checks with AI
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/help-wanted-solved-kit

Comment @coderabbitai help to get the list of available commands.

@joyful-ii-V-I
joyful-ii-V-I merged commit c11c0af into main Sep 12, 2026
31 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.

The callers answer's next= pointer lands on a --uses call that cannot list the site

1 participant