Fix invalid syntax 2-D array: docstub fixes (IV). by mkcor · Pull Request #8023 · scikit-image/scikit-image

mkcor · 2026-01-15T15:03:41Z

Description

This PR is orthogonal to #8014.

Edit: Here I have addressed the last item in the list of errors that docstub spits out. The last item in the list is a group of warnings.

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 docstring type annotations across multiple image-processing functions to more precisely specify expected input/output shapes, dtypes, and return formats.
Chores
- Tightened an automated typing workflow threshold (minor adjustment) to refine project checks.

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

.github/workflows/typing.yml

src/skimage/filters/rank/_percentile.py

stefanv

This looks good to me. We have to resolve the "2-D ndarray" issue, and the "same dtype is input image" spelling.

src/skimage/filters/rank/_percentile.py

src/skimage/draw/_random_shapes.py

src/skimage/filters/rank/_percentile.py

coderabbitai · 2026-01-16T16:16:55Z

📝 Walkthrough

Walkthrough

Reduced the docstub allowed-errors threshold in the typing CI workflow and updated multiple docstrings to use explicit ndarray shape/dtype descriptions and to document masks as tuples of pixel coordinates; no functional or API signature changes.

Changes

Cohort / File(s)	Summary
CI typing workflow `/.github/workflows/typing.yml`	Adjusted the docstub invocation: `--allow-errors` lowered from `895` to `848`. No other workflow flags or control flow changed.
Docstring — random shapes masks `src/skimage/draw/_random_shapes.py`	Updated Returns documentation: `indices` → `mask : tuple` described as a tuple of pixel coordinates for generated shapes; documentation-only.
Docstring — edge filters `src/skimage/filters/edges.py`	Replaced generic "2-D array" descriptions with `ndarray of shape (M, N)` and clarified outputs as `ndarray of shape (M, N) and dtype float`; documentation-only.
Docstring — rank percentile filters `src/skimage/filters/rank/_percentile.py`	Clarified parameter and return docstrings to use `ndarray` with explicit shapes/dtypes for image, footprint, and out arguments; documentation-only.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Fix invalid syntax (..., C=3, ...) ndarray: docstub fixes (VI). #8026 — Similar docstub/docstring wording fixes and updates to the same .github/workflows/typing.yml docstub allowed-errors threshold.

Poem

🐇 I hopped through lines of doc and code,

Tuned a number, smoothed a mode.
Masks now speak as tuples true,
Shapes and dtypes clearer too.
A tiny nibble, tidy and bold.

🚥 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 accurately reflects the main changes: updating docstrings across multiple files to fix docstub validation issues related to 2-D array syntax and documentation improvements.
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.}

.github/workflows/typing.yml

src/skimage/filters/rank/_percentile.py

The order and type in the Return section didn't match the implementation this should improve the situation.

Co-authored-by: Marianne Corvellec <marianne.corvellec@ens-lyon.org>

src/skimage/filters/rank/_percentile.py

lagru

Looks good.

mkcor

Thanks for the thorough enough review, @lagru! 🙏

src/skimage/draw/_random_shapes.py

Co-authored-by: Marianne Corvellec <marianne.corvellec@ens-lyon.org>

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

Address 2-D array docstub error

a73d7c2

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

mkcor commented Jan 15, 2026

View reviewed changes

.github/workflows/typing.yml Outdated Show resolved Hide resolved

mkcor commented Jan 15, 2026

View reviewed changes

src/skimage/filters/rank/_percentile.py Show resolved Hide resolved

stefanv reviewed Jan 15, 2026

View reviewed changes

src/skimage/filters/rank/_percentile.py Show resolved Hide resolved

src/skimage/filters/rank/_percentile.py Show resolved Hide resolved

mkcor mentioned this pull request Jan 15, 2026

Address docstub errors (V) #8024

Merged

lagru reviewed Jan 16, 2026

View reviewed changes

src/skimage/draw/_random_shapes.py Outdated Show resolved Hide resolved

lagru reviewed Jan 16, 2026

View reviewed changes

src/skimage/filters/rank/_percentile.py Outdated Show resolved Hide resolved

mkcor added 2 commits January 16, 2026 17:15

Fix merge conflicts

8f11962

Update number of docstub errors

980c8a6

mkcor commented Jan 16, 2026

View reviewed changes

.github/workflows/typing.yml Outdated Show resolved Hide resolved

mkcor commented Jan 16, 2026

View reviewed changes

src/skimage/filters/rank/_percentile.py Outdated Show resolved Hide resolved

mkcor commented Jan 16, 2026

View reviewed changes

src/skimage/filters/rank/_percentile.py Outdated Show resolved Hide resolved

mkcor and others added 4 commits January 16, 2026 17:29

Specify uint8 or uint16 instead of just int

1012921

Fix return section of _generate_*_mask

97da750

The order and type in the Return section didn't match the implementation this should improve the situation.

Add shape information to footprint

d03176f

Co-authored-by: Marianne Corvellec <marianne.corvellec@ens-lyon.org>

Set shape for other footprints too

0052e08

mkcor commented Jan 17, 2026

View reviewed changes

src/skimage/filters/rank/_percentile.py Outdated Show resolved Hide resolved

lagru approved these changes Jan 17, 2026

View reviewed changes

mkcor commented Jan 17, 2026

View reviewed changes

src/skimage/draw/_random_shapes.py Outdated Show resolved Hide resolved

src/skimage/draw/_random_shapes.py Outdated Show resolved Hide resolved

src/skimage/draw/_random_shapes.py Outdated Show resolved Hide resolved

src/skimage/draw/_random_shapes.py Outdated Show resolved Hide resolved

lagru and others added 3 commits January 18, 2026 12:32

Apply suggestions from code review

30679ff

Co-authored-by: Marianne Corvellec <marianne.corvellec@ens-lyon.org>

Merge branch 'main' into ghpr/8023_docstub-fixes-IV

80c8e75

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

Update error count of docstub

715d7b5

lagru merged commit d2e0b89 into scikit-image:main Jan 18, 2026
23 of 25 checks passed

stefanv added this to the 0.27 milestone Jan 18, 2026

mkcor deleted the docstub-fixes-IV branch January 18, 2026 14:47

This was referenced Jan 18, 2026

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

Merged

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

Merged

This was referenced Jan 22, 2026

Fix 2-D array docstub error (9) #8033

Open

Fix (M, N[, ...]) ndarray docstub error (11). #8037

Open

coderabbitai bot mentioned this pull request Feb 14, 2026

Fix conventions following docstub and misc. #8055

Merged

Uh oh!

Conversation

mkcor commented Jan 15, 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!

Uh oh!

Uh oh!

stefanv left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot commented Jan 16, 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

Poem

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lagru left a comment

Choose a reason for hiding this comment

Uh oh!

mkcor left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mkcor commented Jan 15, 2026 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 16, 2026 •

edited

Loading