Skip to content

Extend UnitOfReactivePower with 'kvar' #38466

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

Merged
merged 1 commit into from
Apr 9, 2025

Conversation

skrynklarn
Copy link

@skrynklarn skrynklarn commented Apr 9, 2025

Proposed change

Add kvar as unit to reactive power

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 the reactive power measurement description to reflect both "var" and "kvar" units for improved clarity.
  • Style
    • Applied minor formatting adjustments to enhance consistency in the documentation.

@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels Apr 9, 2025
Copy link

netlify bot commented Apr 9, 2025

Deploy Preview for home-assistant-docs ready!

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

@skrynklarn skrynklarn changed the title Extend UnitOfReactivePower with 'kvar' #142558 Extend UnitOfReactivePower with 'kvar' Apr 9, 2025
@skrynklarn skrynklarn marked this pull request as ready for review April 9, 2025 18:51
@skrynklarn skrynklarn requested a review from a team as a code owner April 9, 2025 18:51
Copy link
Contributor

coderabbitai bot commented Apr 9, 2025

📝 Walkthrough

Walkthrough

The update refines documentation for the reactive_power device class in both number and sensor integrations. The description now specifies that reactive power may be measured in either "var" or "kvar" instead of only "var". Additionally, a minor formatting adjustment was made in the numbers documentation by removing an extra empty line before the "## Actions" section.

Changes

File(s) Change Summary
source/_integrations/number.markdown, sensor.markdown Updated the reactive_power device class description from "measured in var" to "measured in var or kvar". Additionally, number.markdown saw a minor formatting change (removal of an extra empty line).

📜 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 2a09cd1 and 53a561a.

📒 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)

89-89: Update: Expanded reactive power unit definition.

The documentation now clearly indicates that reactive power can be measured in either var or kvar. This update is clear and consistent with the PR objectives. Please verify that any other references to reactive power in the docs are also updated accordingly, if applicable.

source/_integrations/number.markdown (1)

78-78: Update: Revised reactive power device class description.

The change correctly expands the unit to “var or kvar” for reactive power, ensuring consistency with the sensor documentation. Additionally, the minor formatting adjustment (removing an extra empty line before the "## Actions" section) aligns with the documentation standards.


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.

@github-project-automation github-project-automation bot moved this from Todo to Approved in Documentation PRs Apr 9, 2025
@home-assistant home-assistant bot added the parent-merged The parent PR has been merged already label Apr 9, 2025
@abmantis abmantis merged commit 1ae6407 into home-assistant:next Apr 9, 2025
7 checks passed
@home-assistant home-assistant bot removed the parent-merged The parent PR has been merged already label Apr 9, 2025
@github-project-automation github-project-automation bot moved this from Approved to Done in Documentation PRs Apr 9, 2025
@skrynklarn skrynklarn deleted the reactive-power-kvar branch April 9, 2025 19:39
@github-actions github-actions bot locked and limited conversation to collaborators Apr 10, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants