Update mmc5603.rst #5182
Update mmc5603.rst #5182
Conversation
Adding a hint that the labling on the adafruit mmc5603 breakouts is not correct. Please see adafruit/Adafruit_MMC56x3#4 for further information
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughA warning note was added to the documentation for the MMC5603 sensor, clarifying a labeling error on Adafruit breakout boards. The note provides a translation table for the mislabeled axes and reassures users that the sensor data from ESPHome is correct. No code or configuration changes were made. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested labels
Suggested reviewers
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. ✨ Finishing Touches🧪 Generate unit tests
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: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
components/sensor/mmc5603.rst(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**
⚙️ CodeRabbit Configuration File
- Do not generate or add any sequence diagrams
Files:
components/sensor/mmc5603.rst
🧠 Learnings (1)
📓 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: clydebarrow
PR: esphome/esphome-docs#0
File: :0-0
Timestamp: 2025-05-05T05:08:25.575Z
Learning: In ESPHome documentation, leading slashes in doc references are necessary when the source document is not at the root of the tree, as absolute paths to referenced documents are required in this context.
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.
🪛 GitHub Actions: Lint
components/sensor/mmc5603.rst
[error] 31-31: Sphinx build error: Line block ends without a blank line. This warning is treated as an error in html-strict build.
| Translation table: | ||
|
|
||
| | Axis labeling (wrong) | Sensor axis (correct & returned by ESPHome) | | ||
| |-----------------------|---------------------------------------------| |
There was a problem hiding this comment.
Sphinx build breaks – blank line required before the table inside the admonition
html-strict fails (Line block ends without a blank line) because the simple-table starts immediately after the “Translation table:” line.
Insert a blank line (indented four spaces) before the first | row.
- Translation table:
- | Axis labeling (wrong) | Sensor axis (correct & returned by ESPHome) |
+ Translation table:
+
+ | Axis labeling (wrong) | Sensor axis (correct & returned by ESPHome) |🧰 Tools
🪛 GitHub Actions: Lint
[error] 31-31: Sphinx build error: Line block ends without a blank line. This warning is treated as an error in html-strict build.
🤖 Prompt for AI Agents
In components/sensor/mmc5603.rst around lines 28 to 31, the Sphinx build fails
because the table starts immediately after the "Translation table:" line inside
an admonition without a blank line. Fix this by adding a blank line indented
four spaces before the first table row line starting with `|` to separate the
paragraph from the table properly.
Adding a hint that the labling on the adafruit mmc5603 breakouts is not correct. Please see adafruit/Adafruit_MMC56x3#4 for further information
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
/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: