[max7219digit] Fix incorrect action names in documentation#6131
[max7219digit] Fix incorrect action names in documentation#6131ximex merged 1 commit intoesphome:currentfrom
Conversation
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
Fixes the max7219digit component documentation so the documented automation action names match the actual registered action prefix (max7219digit.*), and aligns the action section heading levels with the rest of the page.
Changes:
- Replace incorrect
MAX7219.*action names withmax7219digit.*. - Change
reverseandintensityaction headings from##to###. - Minor wording adjustments in the actions section (e.g., “With these actions…”).
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughThis PR corrects documentation for the MAX7219 digit display component by renaming action references from the incorrect Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
src/content/docs/components/display/max7219digit.mdx (1)
100-100: Nit: ambiguous phrasing in reverse-action description."from left to right to right to left" is hard to parse. Hyphens make the directional pairs unambiguous.
✏️ Proposed fix
-With these actions you can reverse the display direction from left to right to right to left. +With these actions you can reverse the display direction from left-to-right to right-to-left.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/components/display/max7219digit.mdx` at line 100, The sentence in src/content/docs/components/display/max7219digit.mdx ("With these actions you can reverse the display direction from left to right to right to left.") is ambiguous; update it to use hyphenated directional pairs for clarity—e.g. change the text to "With these actions you can reverse the display direction from left-to-right to right-to-left." Locate and edit the line containing that sentence in the Max7219Digit documentation and replace it with the hyphenated version (left-to-right / right-to-left) to make the reversal description unambiguous.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/content/docs/components/display/max7219digit.mdx`:
- Around line 88-104: Docs mention actions as max7219digit.* but the runtime
currently registers them as max7129digit.*; add a temporary MDX callout (using >
[!NOTE]) near the top of this section warning that users may need to use the
erroneous max7129digit.* action names until the esphome fix is released, list
both examples (e.g., max7219digit.reverse_on vs max7129digit.reverse_on),
reference issue `#14154` for context, and include a short TODO to remove the note
once the esphome-side PR is merged.
- Around line 106-107: The docs state the max7219digit action parameter
"intensity" as both Required and "Defaults to '15'"; remove the contradiction by
deleting the "Defaults to '15'." clause (or alternatively mark it optional and
keep the default) in the max7219digit.intensity parameter description in
src/content/docs/components/display/max7219digit.mdx so the documentation either
requires the caller to supply intensity or shows the default, but not both.
---
Nitpick comments:
In `@src/content/docs/components/display/max7219digit.mdx`:
- Line 100: The sentence in src/content/docs/components/display/max7219digit.mdx
("With these actions you can reverse the display direction from left to right to
right to left.") is ambiguous; update it to use hyphenated directional pairs for
clarity—e.g. change the text to "With these actions you can reverse the display
direction from left-to-right to right-to-left." Locate and edit the line
containing that sentence in the Max7219Digit documentation and replace it with
the hyphenated version (left-to-right / right-to-left) to make the reversal
description unambiguous.
00cf327 to
117dd91
Compare
The documented action names used `MAX7219.*` (e.g. `MAX7219.reverse_on`) but the actual registered actions use the `max7219digit.*` prefix. Also fix heading levels for reverse and intensity actions. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
117dd91 to
acbde16
Compare
Description
The documented action names for the max7219digit component incorrectly used the
MAX7219.*prefix (e.g.MAX7219.reverse_on,MAX7219.invert_on). The actual registered action names use themax7219digit.*prefix (e.g.max7219digit.reverse_on,max7219digit.invert_on).This also fixes the heading levels for the
reverseandintensityaction sections which were##instead of###like the other action headings.Related issue (if applicable): fixes esphome/esphome#14154
Pull request in esphome with YAML changes (if applicable):
max7129digit.*instead ofmax7219digit.*— that will need a separate esphome PR)Checklist
I am merging into
nextbecause this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
currentbecause this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.Link added in
/src/content/docs/components/index.mdxwhen creating new documents for new components or cookbook.