Fix invalid syntax (..., C=3, ...) ndarray: docstub fixes (VI).#8026
Merged
lagru merged 1 commit intoscikit-image:mainfrom Jan 18, 2026
Merged
Fix invalid syntax (..., C=3, ...) ndarray: docstub fixes (VI).#8026lagru merged 1 commit intoscikit-image:mainfrom
lagru merged 1 commit intoscikit-image:mainfrom
Conversation
📝 WalkthroughWalkthroughThe PR adjusts the allowed-errors threshold in a GitHub Actions typing validation workflow from 947 to 895, and standardizes docstring type annotations in color conversion functions to use "array_like of shape (...)" format instead of the previous pattern. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
Comment |
mkcor
added a commit
that referenced
this pull request
Jan 19, 2026
## Description Follows #8026, going through the list of docstub errors, from the bottom up. Fixing similar errors in nearby lines in the same files along the way. ## Checklist <!-- Before pull requests can be merged, they should provide: --> - A descriptive but concise pull request title - [Docstrings for all functions](https://github.com/numpy/numpydoc/blob/main/doc/example.py) - [Unit tests](https://scikit-image.org/docs/dev/development/contribute.html#testing) - A gallery example in `./doc/examples` for new features - [Contribution guide](https://scikit-image.org/docs/dev/development/contribute.html) is followed ## Release note For maintainers and optionally contributors, please refer to the [instructions](https://scikit-image.org/docs/stable/development/contribute.html#documenting-changes) on how to document this PR for the release notes. ```release-note ... ``` <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Clarified parameter and attribute docs across feature-detection, descriptor, measurement, and geometric-transformation APIs—replacing vague “array”/“array-like” descriptions with explicit ndarray shape specifications (e.g., shapes for images, keypoints, scales, orientations, descriptors, positions, residuals). These updates improve consistency and make expected input/output shapes clearer in public documentation. <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Lars Grüter <lagru@mailbox.org>
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.
Description
This PR is orthogonal to all previous docstub-related PRs.
Here I have addressed the second-to-last item in the list of errors that docstub spits out (and a little more, i.e.,
(..., C=3, ...) array_like).Checklist
./doc/examplesfor new featuresRelease note
For maintainers and optionally contributors, please refer to the instructions on how to document this PR for the release notes.
Summary by CodeRabbit
Documentation
Chores
✏️ Tip: You can customize this high-level summary in your review settings.