fix for wrong variable type for remote_receiver::on_pronto#6672
Conversation
fix wrong variable type for remote_receiver::on_pronto
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughThis pull request updates the remote receiver component documentation. The ChangesRemote Receiver Pronto Documentation
🎯 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)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint skipped: no ESLint configuration detected in root package.json. To enable, add 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: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/content/docs/components/remote_receiver.mdx`:
- Line 61: Replace the broken placeholder entry with the restored "pronto"
dumper documentation: add a dump entry named "pronto" (keyword pronto) and a
short description such as "Print remote code in <format> form. Useful for using
arbitrary protocols." so the docs list the pronto codec name and its description
(look for the dump entries block in remote_receiver.mdx and the placeholder line
containing "****" and replace it with the pronto entry).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 6f390160-ff15-4f26-ae1f-543f1cef6b96
📒 Files selected for processing (1)
src/content/docs/components/remote_receiver.mdx
| - **panasonic**: Decode and dump Panasonic infrared codes. | ||
| - **pioneer**: Decode and dump Pioneer infrared codes. | ||
| - **pronto**: Print remote code in Pronto form. Useful for using arbitrary protocols. | ||
| - ****: Print remote code in form. Useful for using arbitrary protocols. |
There was a problem hiding this comment.
Restore the pronto dump entry; current placeholder is broken.
Line 61 currently documents an empty codec name and empty description, so users can’t discover or configure the Pronto dumper correctly.
Proposed doc fix
- - ****: Print remote code in form. Useful for using arbitrary protocols.
+ - **pronto**: Print remote code in Pronto form. Useful for using arbitrary protocols.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - ****: Print remote code in form. Useful for using arbitrary protocols. | |
| - **pronto**: Print remote code in Pronto form. Useful for using arbitrary protocols. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@src/content/docs/components/remote_receiver.mdx` at line 61, Replace the
broken placeholder entry with the restored "pronto" dumper documentation: add a
dump entry named "pronto" (keyword pronto) and a short description such as
"Print remote code in <format> form. Useful for using arbitrary protocols." so
the docs list the pronto codec name and its description (look for the dump
entries block in remote_receiver.mdx and the placeholder line containing "****"
and replace it with the pronto entry).
fix wrong variable type for remote_receiver::on_pronto
Description
Related issue (if applicable): fixes
Pull request in esphome with YAML changes (if applicable):
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.New Component Images
If you are adding a new component to ESPHome, you can automatically generate a standardized black and white component name image for the documentation.
To generate a component image:
Comment on this pull request with the following command, replacing
component_namewith your component name in lower_case format with underscores (e.g.,bme280,sht3x,dallas_temp):The ESPHome bot will respond with a downloadable ZIP file containing the SVG image.
Extract the SVG file and place it in the
/public/images/folder of this repository.Use the image in your component's index table entry in
/src/content/docs/components/index.mdx.Example: For a component called "DHT22 Temperature Sensor", use:
Note: All images used in ImgTable components must be placed in
/public/images/as the component resolves them to absolute paths.