docs: fix indent in UDP Packet Transport #5116
Open
+5
−5
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughThe indentation of a YAML example configuration in the documentation for the UDP packet transport component was corrected. The DHT sensor configuration block now aligns its keys properly under the Changes
Suggested labels
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
components/packet_transport/udp.rst (1)
11-12: Typo: “each over” → “each other”
Minor wording issue that slipped through—readers might stumble over it.- The :ref:`packet-transport` platform allows ESPHome nodes to directly communicate with each over a communication channel. + The :ref:`packet-transport` platform allows ESPHome nodes to directly communicate with each other over a communication channel.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
components/packet_transport/udp.rst(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**
Instructions used from:
Sources:
⚙️ CodeRabbit Configuration File
🧠 Learnings (2)
📓 Common learnings
Learnt from: jesserockz
PR: esphome/esphome-docs#4865
File: .github/workflows/needs-docs.yml:0-0
Timestamp: 2025-05-01T03:29:47.922Z
Learning: In the esphome-docs repository, the "current" label is automatically added by a bot to pull requests, making it a reliable indicator for the target branch.
Learnt from: realzoulou
PR: esphome/esphome-docs#4879
File: components/gps.rst:34-34
Timestamp: 2025-05-04T09:40:22.331Z
Learning: In ESPHome's GPS component, the `update_interval` parameter belongs to the `gps` component itself, not to individual sensors like `altitude`. It should be indented at the same level as the sensor configurations in the YAML.
Learnt from: clydebarrow
PR: esphome/esphome-docs#0
File: :0-0
Timestamp: 2025-05-05T05:08:25.575Z
Learning: For code blocks within YAML documents in ESPHome, maintain YAML format even when the content uses JSON-style syntax, since YAML is a superset of JSON, but not all YAML is valid JSON.
components/packet_transport/udp.rst (1)
Learnt from: realzoulou
PR: esphome/esphome-docs#4879
File: components/gps.rst:34-34
Timestamp: 2025-05-04T09:40:22.331Z
Learning: In ESPHome's GPS component, the `update_interval` parameter belongs to the `gps` component itself, not to individual sensors like `altitude`. It should be indented at the same level as the sensor configurations in the YAML.
🔇 Additional comments (1)
components/packet_transport/udp.rst (1)
28-33: Indentation fix looks good – YAML now parses correctlyThe corrected 2-space shift aligns the
id,pin, and nestedtemperaturekeys under the- platform: dhtlist item, matching ESPHome’s indentation conventions.
No further action needed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
Fixes indent in documentation.
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
/components/index.rstwhen 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 UPPER_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
images/folder of this repository.Use the image in your component's index table entry in
/components/index.rst.Example: For a component called "DHT22 Temperature Sensor", use: