Docstring rework for _resolve_wildcards, distilled into a CLAUDE.md guide - #135
Open
nick-gorman wants to merge 2 commits into
Open
Docstring rework for _resolve_wildcards, distilled into a CLAUDE.md guide#135nick-gorman wants to merge 2 commits into
nick-gorman wants to merge 2 commits into
Conversation
… guide Review feedback on #126 found the _resolve_wildcards docstring confusing — both its structure and its coined terminology (wildcardable, designed drops). Rewording it produced a set of transferable lessons: established terminology only, a narrative structure that motivates the input's oddities before the mechanism, precision about compound cases, and verifying provenance claims against call sites. These are now captured in CLAUDE.md as a docstring guide for generic helpers, and demonstrated on a second function in the same situation, _fuzzy_match_names. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests.
🚀 New features to boost your workflow:
|
The greedy loop accepts scores at the threshold (>=), not only above it, and the canonical sub-region names live in mappings.py, not the nodes table they're used to build. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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.
Follows up Ellie's review feedback on #126 that the
_resolve_wildcardsdocstring was confusing. This PR rewords that docstring, and since the rewording surfaced lessons that seemed transferable, captures them as a new CLAUDE.md section on documenting generic helpers, then tests the guide by getting claude to apply it again to to a similar function,_fuzzy_match_names. Genuinely curious if you think this is a decent improvement across both functions. It's also so pretty verbose so we'd need to watch out it isn't biting too often.