Skip to content

Update mmc5603.rst #5182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: current
Choose a base branch
from
+15 −0
Open

Update mmc5603.rst #5182

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions components/sensor/mmc5603.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,21 @@ for this sensor to work.

.. _Adafruit: https://www.adafruit.com/product/5579

.. warning::

There is an error in the axis labeling of the MMC5603 breakouts from Adafruit.

Translation table:

| Axis labeling (wrong) | Sensor axis (correct & returned by ESPHome) |
|-----------------------|---------------------------------------------|
Comment on lines +28 to +31
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

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.

| X | Y |
| Y | -X |
| Z | Z |


Please note that the returned values in the library are correct. Only the label on the breakout is wrong.

.. code-block:: yaml

# Example configuration entry
Expand Down
Loading