Skip to content

Update CONTRIBUTING in light of docstub#8053

Closed
mkcor wants to merge 1 commit intomainfrom
mkcor-patch-1
Closed

Update CONTRIBUTING in light of docstub#8053
mkcor wants to merge 1 commit intomainfrom
mkcor-patch-1

Conversation

@mkcor
Copy link
Copy Markdown
Member

@mkcor mkcor commented Feb 13, 2026

Proofread contribution guidelines; update array doctype.

Description

Checklist

Release note

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

...

@mkcor
Update CONTRIBUTING in light of docstub
9ba6662 
Proofread contribution guidelines for array docstring and dataset references.
@mkcor mkcor added the 📄 type: Documentation Updates, fixes and additions to documentation label Feb 13, 2026
@mkcor mkcor requested a review from stefanv February 13, 2026 22:08
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Feb 13, 2026

📝 Walkthrough

Walkthrough

Updates documentation formatting in CONTRIBUTING.rst, including parameter documentation style changes from "(M, N) ndarray" to "ndarray of shape (M, N)", capitalization fixes for GitHub and GitLab references, and code formatting consistency for skimage.data.\* references.

Changes

Cohort / File(s) Summary
Documentation and Style Updates
CONTRIBUTING.rst		 Parameter documentation format standardization, capitalization corrections for external service names (GitHub, GitLab), and code formatting additions around skimage.data.\* references.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested labels

:page_facing_up: type: Documentation

Suggested reviewers

  • lagru
🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: updating the CONTRIBUTING documentation in response to docstring format updates, which aligns with the changeset's focus on documentation improvements.
Description check ✅ Passed The description is directly related to the changeset, describing the proofread of contribution guidelines and updates to array doctype formatting mentioned in the summary of changes.
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
  • Commit unit tests in branch mkcor-patch-1

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.

@mkcor
Copy link
Copy Markdown
Member Author

mkcor commented Feb 14, 2026

Oops, I apologize this new branch wasn't created from my fork. I'll resubmit.

@mkcor mkcor closed this Feb 14, 2026
@mkcor mkcor mentioned this pull request Feb 14, 2026
Merged
lagru pushed a commit that referenced this pull request Feb 24, 2026
@mkcor
Fix conventions following docstub and misc. (#8055)
89009eb 
Overrides #8053.
matusvalo pushed a commit to matusvalo/scikit-image that referenced this pull request Mar 4, 2026
@mkcor @matusvalo
Fix conventions following docstub and misc. (scikit-image#8055)
3742b96 
Overrides scikit-image#8053.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@stefanv stefanv Awaiting requested review from stefanv

Assignees

No one assigned

Labels

📄 type: Documentation Updates, fixes and additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@mkcor