Fix schema annotations in misc component docs#6186
Fix schema annotations in misc component docs#6186jesserockz merged 1 commit intoesphome:currentfrom
Conversation
Templatable fixes: - analog_threshold: add missing comma before [templatable] on threshold, upper, lower fields - bm8563: add missing [templatable] to timer duration Required/Optional fixes (verified against source code): - nextion text_sensor: component_name is Required not Optional - ektf2232: reset_pin and interrupt_pin are Required not Optional - lilygo_t5_47: interrupt_pin is Required not Optional - tt21100: interrupt_pin is Optional not Required - sigma_delta_output: update_interval is Optional (default 60s) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
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. 📒 Files selected for processing (7)
✨ 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 |
✅ 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
This PR fixes schema annotation errors across 7 component documentation files, correcting both [templatable] formatting (missing comma separators that caused the type token to be mis-parsed) and Required/Optional mismatches (verified against ESPHome Python source).
Changes:
- Add missing commas before
[templatable]markers inbinary_sensor/analog_threshold.mdx(threshold, upper, lower) and add[templatable]tobm8563.mdxtimer duration - Fix Required/Optional markers:
component_nameintext_sensor/nextion.mdx→ Required;reset_pin/interrupt_pinintouchscreen/ektf2232.mdx→ Required;interrupt_pinintouchscreen/lilygo_t5_47.mdx→ Required;interrupt_pinintouchscreen/tt21100.mdx→ Optional;update_intervalinoutput/sigma_delta_output.mdx→ Optional with default
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
src/content/docs/components/binary_sensor/analog_threshold.mdx |
Adds commas before [templatable] on threshold, upper, and lower to fix schema_doc.py type token parsing |
src/content/docs/components/time/bm8563.mdx |
Adds [templatable] annotation to duration field in bm8563.start_timer action |
src/content/docs/components/text_sensor/nextion.mdx |
Changes component_name from Optional to Required |
src/content/docs/components/touchscreen/ektf2232.mdx |
Changes reset_pin and interrupt_pin from Optional to Required |
src/content/docs/components/touchscreen/lilygo_t5_47.mdx |
Changes interrupt_pin from Optional to Required |
src/content/docs/components/touchscreen/tt21100.mdx |
Changes interrupt_pin from Required to Optional |
src/content/docs/components/output/sigma_delta_output.mdx |
Changes update_interval from Required to Optional and adds default value |
Summary
Fixes templatable formatting and Required/Optional mismatches across 7 component documentation files, verified against ESPHome Python source code.
Templatable fixes
binary_sensor/analog_threshold.mdx— add missing comma before[templatable]on threshold, upper, lower (validator parsedfloat [templatable]as a single type token)time/bm8563.mdx— add missing[templatable]to timer durationRequired/Optional fixes
text_sensor/nextion.mdx—component_name: Optional → Required (source:nextion/base_component.py)touchscreen/ektf2232.mdx—reset_pin,interrupt_pin: Optional → Requiredtouchscreen/lilygo_t5_47.mdx—interrupt_pin: Optional → Requiredtouchscreen/tt21100.mdx—interrupt_pin: Required → Optionaloutput/sigma_delta_output.mdx—update_interval: Required → Optional (default 60s, frompolling_component_schema)Test plan
🤖 Generated with Claude Code