Fix invalid syntax (N, 2) array: docstub fixes (VII). by mkcor · Pull Request #8027 · scikit-image/scikit-image

mkcor · 2026-01-18T21:30:01Z

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

A descriptive but concise pull request title
Docstrings for all functions
Unit tests
A gallery example in ./doc/examples for new features
Contribution guide is followed

Release 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
- 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.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

coderabbitai · 2026-01-18T21:30:16Z

📝 Walkthrough

Walkthrough

Docstrings across feature, measure, and transform modules were updated to explicitly state ndarray shapes (e.g., "ndarray of shape (N, 2)"). The CI typing workflow docstub step had its --allow-errors threshold lowered from 792 to 744. No executable code or public signatures were modified.

Changes

Cohort / File(s)	Summary
Workflow configuration `\.github/workflows/typing.yml`	Lowered docstub `--allow-errors` value from `792` → `744` in the "Create skimage-stubs with docstub" step; command structure unchanged.
Feature detection docstrings `src/skimage/feature/brief.py`, `src/skimage/feature/censure.py`, `src/skimage/feature/orb.py`, `src/skimage/feature/sift.py`	Rewrote parameter and public-attribute descriptions to use explicit "ndarray of shape ..." wording (keypoints, scales, orientations, responses, descriptors, images); no behavioral changes.
Utility / measurement / transform docstrings `src/skimage/feature/util.py`, `src/skimage/measure/fit.py`, `src/skimage/transform/_geometric.py`	Updated docstrings to specify ndarray or array_like shapes for parameters and returns (e.g., `(N, 2)` → `ndarray of shape (N, 2)`); no signature or logic changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Fix invalid syntax (..., C=3, ...) ndarray: docstub fixes (VI). #8026 — Also modifies the docstub typing workflow and docstring/type-stub edits.
Fix invalid syntax 2-D array: docstub fixes (IV). #8023 — Similar docstub workflow change and broad docstring shape/type clarifications.
Fix invalid syntax (M, N) ndarray: docstub fixes (III). #8014 — Overlapping docstring/shape-annotation edits across transform and feature modules.

Suggested reviewers

mkcor

Poem

🐰 I hop through docstrings, nibbling vague arrays,
"ndarray of shape" now lights my ways,
CI trims the threshold, the rabbits cheer,
Clean shapes, clear lines — documentation near,
A tiny hop for code, a joyful ear.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and specifically describes the main change: fixing invalid syntax in docstring array notation (e.g., '(N, 2) array') across multiple files as part of a docstub fixes series.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

📝 Generate docstrings

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

src/skimage/feature/brief.py

coderabbitai

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@src/skimage/feature/orb.py`:
- Line 62: The docstring for the `keypoints` attribute in
src/skimage/feature/orb.py repeats the shape twice; update the `keypoints`
description to remove the redundant `(N, 2)` prefix so it reads in the standard
form (e.g., "ndarray of shape (N, 2)") and ensure similar formatting is used for
other attributes in the same docstring for consistency with the rest of the PR.

🧹 Nitpick comments (1)

src/skimage/transform/_geometric.py (1)
1712-1718: Inconsistent return shape in docstring.

The parameter coords is documented as array_like of shape (N, D) to support D-dimensional coordinates, but the return type is documented as array of shape (N, 2). Since the implementation at line 1722 uses np.empty_like(coords, np.float64), the output shape matches the input shape.

Consider updating the return docstring to match the parameter's dimensionality:
♻️ Suggested fix
         Returns
         -------
-        coords : array of shape (N, 2)
+        coords : ndarray of shape (N, D)
             Transformed coordinates.

src/skimage/feature/orb.py

src/skimage/transform/_geometric.py

# Conflicts: # .github/workflows/typing.yml

lagru

Thanks, looks good.

mkcor added 2 commits January 18, 2026 22:24

Fix invalid syntax (N, 2) array

b68984e

Update number of docstub errors

fa552c0

mkcor added 🔧 type: Maintenance Refactoring and maintenance of internals 🧩 typing Type annotations, type checking, and stubs labels Jan 18, 2026

mkcor requested a review from lagru January 18, 2026 21:30

mkcor commented Jan 18, 2026

View reviewed changes

src/skimage/feature/brief.py Show resolved Hide resolved

coderabbitai bot reviewed Jan 18, 2026

View reviewed changes

src/skimage/feature/orb.py Outdated Show resolved Hide resolved

Fix typo

7370c1b

lagru reviewed Jan 19, 2026

View reviewed changes

src/skimage/transform/_geometric.py Outdated Show resolved Hide resolved

mkcor mentioned this pull request Jan 19, 2026

Address docstub errors (V) #8024

Merged

mkcor and others added 2 commits January 19, 2026 14:57

Use single letter to denote size

9ef1a6c

Merge branch 'main' into ghpr/8027_docstub-fixes-VII

67f8344

# Conflicts: # .github/workflows/typing.yml

lagru approved these changes Jan 19, 2026

View reviewed changes

mkcor merged commit 9d61a84 into scikit-image:main Jan 19, 2026
26 checks passed

mkcor deleted the docstub-fixes-VII branch January 19, 2026 17:10

coderabbitai bot mentioned this pull request Jan 20, 2026

Bump docstub to v0.7.0rc0 and fix errors (8) #8028

Merged

This was referenced Feb 13, 2026

Update CONTRIBUTING in light of docstub #8053

Closed

Fix conventions following docstub and misc. #8055

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix invalid syntax (N, 2) array: docstub fixes (VII).#8027

Fix invalid syntax (N, 2) array: docstub fixes (VII).#8027
mkcor merged 5 commits intoscikit-image:mainfrom
mkcor:docstub-fixes-VII

mkcor commented Jan 18, 2026 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jan 18, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Uh oh!

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

lagru left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

mkcor commented Jan 18, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Release note

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jan 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

lagru left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mkcor commented Jan 18, 2026 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 18, 2026 •

edited

Loading