Skip to content

Fix conventions following docstub and misc.#8055

Merged
lagru merged 2 commits intoscikit-image:mainfrom
mkcor:fix-conventions
Feb 24, 2026
Merged

Fix conventions following docstub and misc.#8055
lagru merged 2 commits intoscikit-image:mainfrom
mkcor:fix-conventions

Conversation

@mkcor
Copy link
Copy Markdown
Member

@mkcor mkcor commented Feb 14, 2026

Description

Overrides #8053.

Checklist

Release note

For maintainers and optionally contributors, please refer to the instructions on how to document this PR for the release notes.

...

Proofread contribution guidelines for array docstring and dataset references.
@mkcor mkcor requested a review from lagru February 14, 2026 17:17
@mkcor mkcor added the 📄 type: Documentation Updates, fixes and additions to documentation label Feb 14, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Feb 14, 2026

📝 Walkthrough

Walkthrough

Documentation style standardization across contributing and user guide files, including array parameter notation updates, capitalization fixes for external services (GitHub, GitLab), inline code formatting for module references, and hyphenation normalization.

Changes

Cohort / File(s) Summary
Documentation Style Updates
CONTRIBUTING.rst, doc/source/user_guide/data_types.rst
Array parameter documentation style updated from "(M, N) ndarray" to "ndarray of shape (M, N)"; GitHub/GitLab capitalization fixes; inline code formatting added for skimage.data references; "data-types" hyphenation normalized to "data types".

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • lagru
🚥 Pre-merge checks | ✅ 2 | ❌ 2
❌ Failed checks (2 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Fix conventions following docstub and misc.' is vague and does not clearly summarize the main changes in the changeset, which involve documentation style updates for array parameters, capitalization fixes, and inline code formatting. Make the title more specific by describing the actual changes, such as 'Update documentation conventions for array parameters and code formatting' or 'Fix docstring conventions and formatting in CONTRIBUTING.rst'.
Description check ❓ Inconclusive The description mentions overriding #8053 and includes a standard checklist template, but does not provide meaningful details about what changes are actually made in this pull request. Add a brief summary of the actual changes made, such as updates to documentation style for array parameters and formatting fixes in CONTRIBUTING.rst and data_types.rst.
✅ Passed checks (2 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Merge Conflict Detection ✅ Passed ✅ No merge conflicts detected when merging into main

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

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

No actionable comments were generated in the recent review. 🎉


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@lagru lagru merged commit 89009eb into scikit-image:main Feb 24, 2026
28 checks passed
@stefanv stefanv added this to the 0.27 milestone Feb 24, 2026
matusvalo pushed a commit to matusvalo/scikit-image that referenced this pull request Mar 4, 2026
matthew-brett added a commit that referenced this pull request Apr 10, 2026
* origin/main: (27 commits)
  Move `_shared` to `_skimage2` (#8102)
  Port `pad_footprint` & `mirror_footprint` to `skimage2` (#8094)
  Add rescaling API to skimage2 (#8075)
  Move `skimage2` implementation into `_skimage2` (#8093)
  Undo (double) mirroring in `ski2.morphology.dilation` (#8060)
  Grammar (#8091)
  Move `ensure_spacing` into `skimage2` (#8067)
  Ensure that `skimage2` does not eagerly import `skimage` (#8087)
  Use lazy-loader 0.5 (#8080)
  MAINT: make ellipse fitting forward compatible  (#8054)
  Avoid deprecated assign to ndarray.shape (#8020)
  Avoid circular import in `feature/corner.py` (#8077)
  Turn off coderabbit auto-labeling & label checks (#8070)
  Fix GIL being re-enabled by C++ extensions (#8059)
  Fix conventions following docstub and misc. (#8055)
  Port grayscale morphology operators to skimage2 (#8046)
  Add revised `peak_local_max` to `skimage2` (#8039)
  Allow read-only arrays as input to remap (#7535)
  Add `prescale`  parameter to "blob functions" (#7858)
  Try to make coderabbit respect exisiting type labels (#8042)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📄 type: Documentation Updates, fixes and additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants