Skip to content

Allow liter for gas sensor device class #38221

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

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

Conversation

Arnie97
Copy link

@Arnie97 Arnie97 commented Mar 26, 2025

Proposed change

Allow liter L as a unit for the gas sensor device class.

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • Documentation
    • Updated gas device class descriptions across integrations to include liters as an available measurement unit. This adjustment provides clearer and more comprehensive guidance for gas volume representation.

@home-assistant home-assistant bot added in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Mar 26, 2025
@home-assistant
Copy link

It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the current branch. Please change the target branch of this PR to current and rebase if needed. If this is documentation for a new feature, please add a link to that PR in your description.

@home-assistant home-assistant bot added the next This PR goes into the next branch label Mar 26, 2025
Copy link

netlify bot commented Mar 26, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 7299367
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/67e44afcac761f0007893e22
😎 Deploy Preview https://deploy-preview-38221--home-assistant-docs.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.

@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo and removed needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Mar 26, 2025
@Arnie97 Arnie97 marked this pull request as ready for review March 26, 2025 19:20
@Arnie97 Arnie97 requested a review from a team as a code owner March 26, 2025 19:20
Copy link
Contributor

coderabbitai bot commented Mar 26, 2025

📝 Walkthrough

Walkthrough

The pull request updates the gas device class descriptions in two markdown integration files. Both files now specify the supported gas volume units as "L, m³, ft³ or CCF," replacing the previous version that omitted liters and used "Gasvolume" without a space. The changes are limited to text adjustments in the documentation with no structural modifications.

Changes

File(s) Summary
source/.../number.markdown, source/.../sensor.markdown Updated the gas device class description from "Gasvolume in m³, ft³ or CCF" to "Gas volume in L, m³, ft³ or CCF".

📜 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 4291172 and 7299367.

📒 Files selected for processing (2)
  • source/_integrations/number.markdown (2 hunks)
  • source/_integrations/sensor.markdown (1 hunks)
🔇 Additional comments (2)
source/_integrations/sensor.markdown (1)

70-70: Clarify gas device class units by adding liter support.
The updated device class entry now reads "Gas volume in L, m³, ft³ or CCF," which correctly introduces liters (L) as a valid unit and improves clarity by adding a space between "Gas" and "volume." This aligns perfectly with the PR objective.

source/_integrations/number.markdown (1)

59-59: Include liter unit in gas device class description for numbers.
The modified line now specifies "Gas volume in L, m³, ft³ or CCF," ensuring consistency with the sensor integration documentation and meeting the PR objective.


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 plan to trigger planning for file edits and PR creation.
  • @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 or @coderabbitai title 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
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

✅ Approved. Can be merged as soon as the parent PR gets merged.

@github-project-automation github-project-automation bot moved this from Todo to Approved in Documentation PRs Apr 14, 2025
@frenck frenck added the awaits-parent Awaits the merge of an parent PR label Apr 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaits-parent Awaits the merge of an parent PR has-parent This PR has a parent PR in a other repo in-progress This PR/Issue is currently being worked on next This PR goes into the next branch
Projects
No open projects
Status: Approved
Development

Successfully merging this pull request may close these issues.

2 participants