Skip to content
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

Open
wants to merge 1 commit into
base: current
Choose a base branch
from

Conversation

osirisinferi
Copy link

Description:

Some years ago, in 3ece925 the options oversampling and range 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 duplicate range was removed, but the duplicate entry for oversampling 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):

  • N/A

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.

@osirisinferi osirisinferi changed the title Remove duplicate configuration option [hmc5883l] Remove duplicate configuration option Mar 15, 2025
Copy link
Contributor

coderabbitai bot commented Mar 15, 2025

Walkthrough

The 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

File Change Summary
components/sensor/hmc5883l.rst Removed the duplicate oversampling description, retaining only the detailed explanation specifying allowed readings and default.

Sequence Diagram(s)

(No sequence diagram is generated as there are no new features or control flow modifications.)

Suggested reviewers

  • DjordjeMandic

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 85767e4 and 15ee462.

📒 Files selected for processing (1)
  • components/sensor/hmc5883l.rst (0 hunks)
💤 Files with no reviewable changes (1)
  • components/sensor/hmc5883l.rst
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

netlify bot commented Mar 15, 2025

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit 15ee462
🔍 Latest deploy log https://app.netlify.com/sites/esphome/deploys/67d5f247836c3d0008fa3370
😎 Deploy Preview https://deploy-preview-4757--esphome.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant