Skip to content

Fix schema annotations in misc component docs#6186

Merged
jesserockz merged 1 commit intoesphome:currentfrom
swoboda1337:fix/nextion-ezo-fingerprint-templatable
Mar 1, 2026
Merged

Fix schema annotations in misc component docs#6186
jesserockz merged 1 commit intoesphome:currentfrom
swoboda1337:fix/nextion-ezo-fingerprint-templatable

Conversation

@swoboda1337
Copy link
Member

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 parsed float [templatable] as a single type token)
  • time/bm8563.mdx — add missing [templatable] to timer duration

Required/Optional fixes

  • text_sensor/nextion.mdxcomponent_name: Optional → Required (source: nextion/base_component.py)
  • touchscreen/ektf2232.mdxreset_pin, interrupt_pin: Optional → Required
  • touchscreen/lilygo_t5_47.mdxinterrupt_pin: Optional → Required
  • touchscreen/tt21100.mdxinterrupt_pin: Required → Optional
  • output/sigma_delta_output.mdxupdate_interval: Required → Optional (default 60s, from polling_component_schema)

Test plan

  • Verify schema validation errors are resolved for these files
  • Verify rendered docs accurately reflect the source code requirements

🤖 Generated with Claude Code

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>
Copilot AI review requested due to automatic review settings March 1, 2026 02:50
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 1, 2026

Warning

Rate limit exceeded

@swoboda1337 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 5 minutes and 12 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

📥 Commits

Reviewing files that changed from the base of the PR and between d5dff81 and 2de8f84.

📒 Files selected for processing (7)
  • src/content/docs/components/binary_sensor/analog_threshold.mdx
  • src/content/docs/components/output/sigma_delta_output.mdx
  • src/content/docs/components/text_sensor/nextion.mdx
  • src/content/docs/components/time/bm8563.mdx
  • src/content/docs/components/touchscreen/ektf2232.mdx
  • src/content/docs/components/touchscreen/lilygo_t5_47.mdx
  • src/content/docs/components/touchscreen/tt21100.mdx
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

@netlify
Copy link

netlify bot commented Mar 1, 2026

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit 2de8f84
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/69a3a95b62e3b70008fdbb49
😎 Deploy Preview https://deploy-preview-6186--esphome.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 in binary_sensor/analog_threshold.mdx (threshold, upper, lower) and add [templatable] to bm8563.mdx timer duration
  • Fix Required/Optional markers: component_name in text_sensor/nextion.mdx → Required; reset_pin/interrupt_pin in touchscreen/ektf2232.mdx → Required; interrupt_pin in touchscreen/lilygo_t5_47.mdx → Required; interrupt_pin in touchscreen/tt21100.mdx → Optional; update_interval in output/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

@jesserockz jesserockz merged commit 8ba5609 into esphome:current Mar 1, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants