Enhance numpy-style docstring detection and update documentation #249
Conversation
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
- Added pattern-based numpy style detection for section headers with dashes - Enhanced parseDocstring() to check for numpy patterns before fallback - Updated style_mismatch.md documentation with new detection logic - Reformatted style_mismatch.md to max 79 chars per line - Added comprehensive test cases for numpy pattern detection - Updated test expectations for enhanced detection behavior - Added branch naming convention to CLAUDE.md 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- isort: 5.13.2 → 6.0.1 - pre-commit-hooks: v5.0.0 → v6.0.0 - pre-commit: v4.0.1 → v4.3.0 This should resolve the cached environment issues causing CI failures. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Remove extra blank lines after headers in CHANGELOG.md and docs/how_to_config.md - Ensures consistent formatting between local and CI environments - Fixes CI pipeline failures caused by prettier version mismatch 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
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.
Fixes #244
Summary
Changes Made
Returns\n-------) before falling back to size-based comparisondocs/style_mismatch.mdwith detailed explanation of the new detection approach and reformatted to 79 chars per linetests/utils/test_parse_docstring.pyand updated existing test expectationsCLAUDE.mdTechnical Details
The new logic in
parseDocstring()first checks for numpy-style patterns using regex to detect section headers followed by 3+ dashes. This provides more accurate detection for numpy-style docstrings and eliminates edge cases where they might be misidentified.Test Plan
🤖 Generated with Claude Code