Fix incorrect heading order summary to not claim specific heading levels - #1825
Conversation
The singular summary hardcoded <h3> after <h1> regardless of the actual heading levels involved, which is misleading. Per pattonwebz's comment on #1561, reword to a generic statement since there's currently no way to pass the actual heading levels into the summary text.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe summary text returned by IncorrectHeadingOrderRule::get_rule() was changed from a sprintf-based, translator-parameterized string to a static esc_html__() translated message describing that a page uses headings out of order. ChangesRule Summary Text Update
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Code Review
This pull request simplifies the 'summary' text in the IncorrectHeadingOrderRule class by removing the sprintf formatting that injected hardcoded heading tags, replacing it with a simpler, static localized string. There are no review comments, so I have no feedback to provide.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: af25621adb
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
The singular summary hardcoded
after
regardless of the
actual heading levels involved, which is misleading. Per pattonwebz's
comment on #1561, reword to a generic statement since there's
currently no way to pass the actual heading levels into the summary
text.
Summary by CodeRabbit