Fix description of accuracy_decimals

[damz]

Description:

Related issue (if applicable): fixes #2164

The description introduced in #2164 doesn't make sense: it says that the accuracy_decimals setting both controls and doesn't control the number of decimals to use when reporting values.

This setting plainly DOES impact the actual value reported to Home Assistant. It also controls the default display precision of the Home Assistant entity, but I do not believe this is a very important information in this context. In the interest of simplicity, I suggest we just remove the second sentence.

Checklist:

• 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.

[coderabbitai]

Walkthrough

The pull request updates the documentation for the Sensor Component in ESPHome, specifically in the components/sensor/index.rst file. It clarifies the configuration options, particularly for accuracy_decimals, and enhances the structure of the documentation for various configuration variables. The section on filters is expanded with detailed explanations and examples, and the automation triggers are elaborated for better guidance. Overall, these changes aim to improve the clarity and comprehensiveness of the documentation.

Changes

Files	Change Summary
components/sensor/index.rst	Updated documentation to clarify configuration options, modified accuracy_decimals section, expanded filters section, and elaborated on automation triggers.

Assessment against linked issues

Objective	Addressed	Explanation
Clarify accuracy_decimals in sensor config (#2164)	✅

Possibly related PRs

• Simplified bulky formulation about sensor filters #4421: This PR also focuses on enhancing the documentation for the Sensor Component, specifically simplifying the explanations related to sensor filters and automation triggers, which aligns closely with the changes made in the main PR.

Suggested labels

current

Suggested reviewers

• nagyrobi

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 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.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 0224cf8 and 5c36b8b.

📒 Files selected for processing (1)

• components/sensor/index.rst (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

components/sensor/index.rst (1)

Pattern **: - Do not generate or add any sequence diagrams

[netlify]

✅ Deploy Preview for esphome ready!

Name	Link
🔨 Latest commit	5c36b8b
🔍 Latest deploy log	https://app.netlify.com/sites/esphome/deploys/675554c9c32a1d0008322fc1
😎 Deploy Preview	https://deploy-preview-4494--esphome.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

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

[damz]

Looking into this a bit more: it is technically true that accuracy_decimals "does not impact the actual value reported to Home Assistant". But the first thing that the Home Assistant integration does is to round the received value based on accuracy_decimals. That makes the second part of the sentence ("it just sets the number of decimals to use when displaying it") incorrect.