-
Notifications
You must be signed in to change notification settings - Fork 1.9k
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.
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
[hmc5883l] Remove duplicate configuration option #4757
base: current
Are you sure you want to change the base?
Conversation
WalkthroughThe documentation for the HMC5883L sensor was updated by removing a redundant oversampling parameter description. Only the detailed line explaining the oversampling values and default remains. The change streamlines the configuration section without altering the overall structure. Changes
Sequence Diagram(s)(No sequence diagram is generated as there are no new features or control flow modifications.) Suggested reviewers
Tip ⚡🧪 Multi-step agentic review comment chat (experimental)
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
💤 Files with no reviewable changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (1)
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:
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 (
|
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Description:
Some years ago, in 3ece925 the options
oversampling
andrange
were added to this documentation. However, some months later, both options were addeed a second time in abf9888. Not sure why the diff of the latter commit doesn't show the former commit and somewhere later on the duplicaterange
was removed, but the duplicate entry foroversampling
remains.This PR removes that duplicate.
I chose to remove the very brief duplicate, as it was also the very brief duplicate of the
range
option that was removed before. But one could argue that the more informative one-liners give as much information about both options as the elaborate paragraphs later in the documentation.. A little bit superfluous, but no harm done I guess 🤷♂️Related issue (if applicable): N/A (no issue opened)
Pull request in esphome with YAML changes (if applicable):
Checklist:
I am merging into
next
because this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
current
because 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.rst
when creating new documents for new components or cookbook.