Fix typos in qmc5883l.rst #5259
Conversation
WalkthroughDocumentation-only edits for the QMC5883L sensor: corrected typos and capitalization, normalized unit notation (µT → uT), clarified I²C references, reworded oversampling descriptions, and added 128x and 64x oversampling options in the docs. No code or API changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested reviewers
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ 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. CodeRabbit Commands (Invoked using PR/Issue comments)Type 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 (4)
components/sensor/qmc5883l.rst (4)
11-14: Good typo fixes; minor style nits for clarity and correctness
- Use “knock-off” (hyphenated).
- Prefer “on par with” instead of “on par to”.
- Consider tightening the last sentence.
-ESPHome. This sensor is very similar to the :ref:`HMC5883L <hmc5883l>` sensor and is often found -as a knock off replacement. The QMC5883L sensor performs on par to the HMC5883L sensor, -though the configuration differs. The :ref:`I²C Bus <i2c>` is required to be set up in your -configuration for this sensor to work. +ESPHome. This sensor is very similar to the :ref:`HMC5883L <hmc5883l>` sensor and is often found +as a knock-off replacement. The QMC5883L sensor performs on par with the HMC5883L sensor, +though the configuration differs. The :ref:`I²C Bus <i2c>` must be configured in your +configuration for this sensor to work.
77-79: Clarify “average of the x samples” phrasing“x” reads like a placeholder. Suggest clarifying that the sensor averages the configured number of samples.
-By default, the QMC5883L sensor measures each value 512 times when requesting a new value. You can, however, -configure this amount. The result is the sensor will take the average of the x samples. Possible sampling values: +By default, the QMC5883L sensor measures each value 512 times when requesting a new value. You can, however, +configure this amount. As a result, the sensor reports the average of the configured number of samples (N). Possible sampling values:
47-47: Fix capitalization and extra space in “I²C address”There’s a double space before “I²c” and the “c” should be capitalized.
-- **address** (*Optional*, int): Manually specify the I²c address of the sensor. Defaults to ``0x0D``. +- **address** (*Optional*, int): Manually specify the I²C address of the sensor. Defaults to ``0x0D``.
71-73: Align unit tokens with YAML example (uT vs µT)The YAML example uses
200uT(Line 41) while the options list usesµ(micro sign). Recommend usinguTin the options list for consistency with the example and to avoid non-ASCII characters in literals. Please verify thatuTis the expected literal in configuration.-- ``200µT`` (default) -- ``800µT`` +- ``200uT`` (default) +- ``800uT``If the configuration truly expects
µT, we should instead change the example at Line 41 to200µT.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
components/sensor/qmc5883l.rst(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**
⚙️ CodeRabbit Configuration File
- Do not generate or add any sequence diagrams
Files:
components/sensor/qmc5883l.rst
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
components/sensor/qmc5883l.rst (1)
68-73: Align magnetic field unit notation site-wideOur documentation currently mixes Unicode “µT” and ASCII “uT” across several sensor pages, which can be confusing. Please pick one convention (we recommend the Unicode “µT” for proper SI notation) and update all occurrences:
• components/sensor/hmc5883l.rst
– Lines 39, 77–87: replaceuTwithµT
– Lines 58–59: already useµT—ensure consistency with the rest of the file• components/sensor/qmc5883l.rst
– Lines 40, 68–72: replaceuTwithµT• components/sensor/mlx90393.rst
– Already usesµT; no changes needed hereMaking this change will ensure a consistent, professional presentation of units across the docs.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
components/sensor/qmc5883l.rst(3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**
⚙️ CodeRabbit Configuration File
- Do not generate or add any sequence diagrams
Files:
components/sensor/qmc5883l.rst
🔇 Additional comments (4)
components/sensor/qmc5883l.rst (4)
11-14: Intro wording improvements look goodThe grammar/tone fixes read better and are accurate. No technical meaning changed.
47-47: I²C capitalization/style correctedNice consistency fix; matches typical style in the docs.
77-84: Clarify oversampling wording and confirm supported options
Confirmed that the QMC5883L component supports 512x (default), 256x, 128x, and 64x oversampling. Please apply this wording tweak in components/sensor/qmc5883l.rst (lines 77–84):-By default, the QMC5883L sensor measures each value 512 times when requesting a new value. You can, however, -configure this amount. The sensor reports the average of the configured number of samples (N). Possible sampling values: +By default, the QMC5883L sensor samples each axis 512 times per measurement. You can configure this. +The sensor reports the average of the configured number of samples (N). Possible sampling values:
40-40: Confirmed: ASCII ‘uT’ is supported
ESPHome’s QMC5883L sensor accepts both “200uT” and “800uT” in YAML as valid range values (the docs example is correct).
Description:
Fix small typos in the QMC5883L docs.
Related issue (if applicable): N/A
Pull request in esphome with YAML changes (if applicable): N/A
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: