Skip to content

Remove deprecated check-docstring-first precommit hook - #1393

Open
kra wants to merge 1 commit into
mainfrom
fix/precommit-docstring-deprecated
Open

Remove deprecated check-docstring-first precommit hook#1393
kra wants to merge 1 commit into
mainfrom
fix/precommit-docstring-deprecated

Conversation

@kra

@kra kra commented Aug 28, 2026

Copy link
Copy Markdown
Collaborator

"check-docstring-first: fundamentally flawed, deprecated without replacement."

https://github.com/pre-commit/pre-commit-hooks#deprecated--replaced-hooks

Summary

Brief description of what this PR does. (tl;dr).

List of Changes

  • Removes pre-commit hook

How to Test the Changes

Run precommit on an otherwise valid source tree and verify that it succeeds.

Summary by CodeRabbit

  • Chores
    • Removed an automated documentation-style check from the pre-commit validation process.

…eadability issue.

"check-docstring-first: fundamentally flawed, deprecated without replacement."

https://github.com/pre-commit/pre-commit-hooks#deprecated--replaced-hooks
@netlify

netlify Bot commented Aug 28, 2026

Copy link
Copy Markdown

Deploy Preview for antenna-preview canceled.

Name Link
🔨 Latest commit 3a33ec7
🔍 Latest deploy log https://app.netlify.com/projects/antenna-preview/deploys/6a9215b608572200080f0c0a

@netlify

netlify Bot commented Aug 28, 2026

Copy link
Copy Markdown

Deploy Preview for antenna-ssec canceled.

Name Link
🔨 Latest commit 3a33ec7
🔍 Latest deploy log https://app.netlify.com/projects/antenna-ssec/deploys/6a9215b6601b7b00085ffe12

@coderabbitai

coderabbitai Bot commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: d25e473b-7b3d-4d6c-876e-9ad819bce162

📥 Commits

Reviewing files that changed from the base of the PR and between ffefa68 and 3a33ec7.

📒 Files selected for processing (1)
  • .pre-commit-config.yaml
💤 Files with no reviewable changes (1)
  • .pre-commit-config.yaml

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The pre-commit configuration removes the check-docstring-first hook from the pre-commit-hooks repository hook list.

Changes

Pre-commit hook cleanup

Layer / File(s) Summary
Remove docstring hook
.pre-commit-config.yaml
The configuration no longer enables check-docstring-first.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 3a33e

This change removes a deprecated pre-commit hook from the repository configuration; no actionable merge-blocking risk remains beyond normal checks and review.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description includes the change and a test instruction, but it leaves the required Summary and Detailed Description incomplete. It also omits Related Issues, Deployment Notes, and the Checklist. Complete the Summary and Detailed Description sections. State whether the PR relates to an issue, document deployment impact, and include the repository Checklist with applicable items checked. Mark Screenshots as not applicable if needed.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the main change: removal of the deprecated check-docstring-first pre-commit hook.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files.

  • Fix all pre-merge checks with AI
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/precommit-docstring-deprecated

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.

@kra
kra marked this pull request as ready for review August 28, 2026 23:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant