Skip to content

Document MCF as another volume/gas/water unit #2746

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Document MCF as another volume/gas/water unit #2746

wants to merge 2 commits into from

Conversation

pioto
Copy link

@pioto pioto commented Aug 5, 2025 •
edited by coderabbitai bot
Loading

Proposed change

Complementary to home-assistant/home-assistant.io#40281 and home-assistant/core#150015, this documents MCF as another alternative volume unit, as this is how some utilities in the US bill for water or gas.

Type of change

  • Document existing features within Home Assistant
  • Document new or changing features for which there is an existing pull request elsewhere
  • Spelling or grammatical corrections, or rewording for improved clarity
  • Changes to the backend of this documentation
  • Remove stale or deprecated documentation

Checklist

  • I have read and followed the documentation guidelines.
  • I have verified that my changes render correctly in the documentation.

Additional information

Summary by CodeRabbit

  • Documentation
    • Updated documentation to include "MCF" (thousand cubic feet) as a supported unit for gas, volume, volume storage, and water device classes in both number and sensor device class references.

@pioto pioto mentioned this pull request Aug 5, 2025
Open
19 tasks
@pioto pioto marked this pull request as ready for review August 5, 2025 11:34
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 5, 2025

📝 Walkthrough

Walkthrough

The documentation for number and sensor device classes was updated to include "MCF" (thousand cubic feet) as a supported unit for the GAS, VOLUME, VOLUME_STORAGE, and WATER classes. No changes were made to code, logic, or public interfaces—only documentation was modified.

Changes

Cohort / File(s) Change Summary
Number Device Class Documentation
docs/core/entity/number.md		 Updated supported units for GAS, VOLUME, VOLUME_STORAGE, and WATER to include "MCF".
Sensor Device Class Documentation
docs/core/entity/sensor.md		 Added "MCF" to supported units for GAS, VOLUME, VOLUME_STORAGE, and WATER device classes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.
    • Explain this complex logic.
    • 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 explain this code block.
  • 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 explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests 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 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.

coderabbitai[bot]
coderabbitai bot reviewed Aug 5, 2025
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/core/entity/number.md (1)

53-53: MCF addition looks correct; consider clarifying the abbreviation once.

The unit list now contains MCF, which is great. Because M can ambiguously stand for thousand or million in different domains, a one-time footnote or short parenthetical “(thousand ft³)” elsewhere in the doc would pre-empt confusion.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 2321f11 and 8e4e58b.

📒 Files selected for processing (2)
  • docs/core/entity/number.md (2 hunks)
  • docs/core/entity/sensor.md (2 hunks)
🔇 Additional comments (7)
docs/core/entity/number.md (3)

82-82: LGTM – unit list kept in sync with GAS row.

84-84: LGTM – VOLUME_STORAGE now lists MCF.

85-85: LGTM – WATER row updated consistently.

docs/core/entity/sensor.md (4)

56-56: MCF unit added for GAS sensors – looks good.

86-86: Volume sensor units updated – in sync with number docs.

88-88: MCF inclusion for VOLUME_STORAGE confirmed.

89-89: Water sensor row updated – no issues.

@pioto pioto mentioned this pull request Aug 5, 2025
Open
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@pioto