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 minor typos in 2025.1 release notes #36636

Merged
merged 1 commit into from
Jan 2, 2025
Merged

Fix minor typos in 2025.1 release notes #36636

merged 1 commit into from
Jan 2, 2025

Conversation

davet2001
Copy link
Contributor

@davet2001 davet2001 commented Jan 1, 2025

Proposed change

I was taking a sneak peek at the release notes and found a few minor typos so thought I should submit a PR

Not sure my PR is targeting the correct branch. I picked RC because I couldn't find this file in 'next'.

Happy new year!

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

  • Link to parent pull request in the codebase:
  • Link to parent pull request in the Brands repository:
  • This PR fixes or closes issue: fixes #

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

  • New Features

    • Introduced automated backups with mandatory encryption
    • Home Assistant Cloud backup storage for subscribers
    • Enhanced automation and script creation with categories and labels
    • Quick navigation bar for devices
    • Improved energy dashboard with device reordering
    • Media player Tile card volume control
  • Improvements

    • Logbook card now supports event target selection
    • Added support for mWh and mW measurement units
  • Breaking Changes

    • Removal of certain configuration options
    • Standardization of sensor states

@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 rc This PR is against the RC branch labels Jan 1, 2025
@home-assistant
Copy link

home-assistant bot commented Jan 1, 2025

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.

Copy link

netlify bot commented Jan 1, 2025

Deploy Preview for home-assistant-docs ready!

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

@davet2001 davet2001 changed the title Update 2025-01-03-release-20251.markdown Fix minor typos in 2025.1 release notes Jan 1, 2025
Copy link
Contributor

coderabbitai bot commented Jan 1, 2025

📝 Walkthrough

Walkthrough

The pull request introduces updates to the Home Assistant version 2025.1 release notes, focusing on significant improvements in backup functionality, user interface, and integration capabilities. The changes include mandatory backup encryption, cloud backup storage for subscribers, enhanced navigation features for automations and devices, energy dashboard improvements, and expanded integration support. The release notes also address some minor textual corrections and clarifications about supported measurement units.

Changes

File Change Summary
source/_posts/2025-01-03-release-20251.markdown - Updated unit of measurement support (added mW for electrical potential power sensors)
- Refined logbook card functionality description
- Detailed new backup encryption and cloud storage features
- Highlighted UI and navigation improvements

Sequence Diagram

sequenceDiagram
    participant User
    participant HomeAssistant
    participant CloudStorage

    User->>HomeAssistant: Configure Backup Settings
    HomeAssistant->>HomeAssistant: Generate Encryption Key
    HomeAssistant->>CloudStorage: Store Encrypted Backup (for subscribers)
    CloudStorage-->>HomeAssistant: Backup Confirmation
    HomeAssistant-->>User: Backup Complete
Loading

📜 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 50229ce and eb7a260.

📒 Files selected for processing (1)
  • source/_posts/2025-01-03-release-20251.markdown (1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_posts/2025-01-03-release-20251.markdown

[uncategorized] ~463-~463: Consider adding a hyphen.
Context: ...pt editor (the three dotted menu in the top right corner), making it easier to access t...

(TOP_LEFT_CORNER)

🔇 Additional comments (2)
source/_posts/2025-01-03-release-20251.markdown (2)

460-461: LGTM: Unit of measurement update is clearly documented.

The addition of mWh and mW units for energy and power sensors respectively is well documented and follows standard unit conventions.


465-467: ⚠️ Potential issue

Fix grammatical error in logbook card description.

The sentence has a grammatical error in "can supports".

Apply this diff to fix the grammar:

-The [logbook card] supports picking a target for things it should show
+The [logbook card] supports picking targets for things it should show

Likely invalid or redundant comment.


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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
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.

Thanks, @davet2001 👍

../Frenck

@frenck frenck merged commit 3f0d344 into rc Jan 2, 2025
9 checks passed
@home-assistant home-assistant bot removed needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch in-progress This PR/Issue is currently being worked on labels Jan 2, 2025
@frenck frenck deleted the davet2001-patch-2 branch January 2, 2025 09:58
@github-actions github-actions bot locked and limited conversation to collaborators Jan 3, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
rc This PR is against the RC branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants