Repository navigation
BUG Warn on malformed parameter headers - #709
Merged
Merged
Conversation
larsoner
approved these changes
Sep 25, 2026
larsoner
left a comment
larsoner
left a comment
Collaborator
There was a problem hiding this comment.
Looks good, thanks @jiewaishengzhi !
This was referenced Sep 25, 2026
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
3 participants
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.
Closes #677.
NumpyDocStringcurrently treats a malformed header such asval: intas the complete parameter name without warning. This change emits a focused warning when a parameter-like section contains:without the required preceding space.The parsed output remains unchanged. Existing validator coverage continues to assert the structured PR10 diagnostic and now explicitly captures the parser warning.
Tests:
uvx pre-commit run --files numpydoc/docscrape.py numpydoc/tests/test_docscrape.py numpydoc/tests/test_validate.pyuv run --no-project --with-editable . --with pytest --with pytest-cov --with matplotlib python -m pytest -q(317 passed, 1 skipped, 2 xfailed)