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

Fix apparent power typo #2452

Merged
merged 2 commits into from
Nov 14, 2024

Conversation

mikey0000
Copy link
Contributor

@mikey0000 mikey0000 commented Nov 14, 2024

Proposed change

Typo

Type of change

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

Additional information

  • This PR fixes or closes issue: fixes #
  • Link to relevant existing code or pull request:

Summary by CodeRabbit

  • Documentation
    • Corrected a typographical error in the documentation for the number entity.
    • Enhanced clarity and consistency in property and method descriptions.

Copy link
Contributor

coderabbitai bot commented Nov 14, 2024

📝 Walkthrough

Walkthrough

The documentation for the number entity has been updated to correct a typographical error in the device class constant name, changing NumberDeviceClass.APPARANT_POWER to NumberDeviceClass.APPARENT_POWER. Additionally, the documentation has been refined for clarity and consistency, particularly in the descriptions of properties and methods associated with the number entity, while maintaining emphasis on expected behavior and correct unit of measurement.

Changes

File Path Change Summary
docs/core/entity/number.md Updated constant name from APPARANT_POWER to APPARENT_POWER and refined documentation for clarity and consistency.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Documentation
    User->>Documentation: Request information on number entity
    Documentation-->>User: Provide updated documentation
    User->>Documentation: Review constant names and properties
    Documentation-->>User: Display corrected constant and refined descriptions
Loading

Warning

Rate limit exceeded

@mikey0000 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 23 minutes and 10 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 63376ee and a7441d3.


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

🧹 Outside diff range and nitpick comments (1)
docs/core/entity/number.md (1)

34-34: Consider standardizing table formatting.

For consistency in markdown formatting, consider removing the trailing pipe at the end of the table row. While this is a minor formatting issue, it helps maintain a consistent style throughout the documentation.

-| `NumberDeviceClass.APPARENT_POWER` | VA | Apparent power |
+| `NumberDeviceClass.APPARENT_POWER` | VA | Apparent power
🧰 Tools
🪛 Markdownlint

34-34: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 63376ee and a7441d3.

📒 Files selected for processing (1)
  • docs/core/entity/number.md (1 hunks)
🧰 Additional context used
🪛 Markdownlint
docs/core/entity/number.md

34-34: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)

🔇 Additional comments (1)
docs/core/entity/number.md (1)

34-34: LGTM! Spelling correction is accurate.

The change from "APPARANT_POWER" to "APPARENT_POWER" correctly fixes the spelling while maintaining the accurate technical specification (VA unit for apparent power measurement).

🧰 Tools
🪛 Markdownlint

34-34: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)

@mikey0000 mikey0000 changed the title fix typo on apparant which should be apparent Fix typo on apparant which should be apparent Nov 14, 2024
Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Thanks!

@MartinHjelmare MartinHjelmare changed the title Fix typo on apparant which should be apparent Fix apparent power typo Nov 14, 2024
@MartinHjelmare MartinHjelmare merged commit 4e1559b into home-assistant:master Nov 14, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants