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

Update notification texts in Bring #37395

Merged
merged 3 commits into from
Feb 10, 2025

Conversation

tr4nt0r
Copy link
Contributor

@tr4nt0r tr4nt0r commented Feb 10, 2025

Proposed change

Updates the notification texts to match the latest version of the Bring app. It was already updated in Home Assistant core. Also added some additional notes.

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

  • Documentation
    • Updated descriptive text for notification elements in the Bring! integration.
    • Refined language for clarity and consistency, including adjustments to key messages.
    • Introduced a note clarifying that notification displays may vary based on language settings and user profiles.

@home-assistant home-assistant bot added the current This PR goes into the current branch label Feb 10, 2025
Copy link

netlify bot commented Feb 10, 2025

Deploy Preview for home-assistant-docs ready!

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

Copy link
Contributor

coderabbitai bot commented Feb 10, 2025

Caution

Review failed

The head commit changed during the review from b0ccb5a to ff17b13.

📝 Walkthrough

Walkthrough

This pull request updates the Bring! integration documentation for Home Assistant. The modifications refine the descriptions used for data attributes and notification types. Specifically, the description for the item attribute has been updated, and the texts for notification types such as going_shopping and urgent_message have been rephrased. Additionally, a note has been added to clarify that notifications received by list members may differ from the in-app labels based on language settings and sender profiles.

Changes

File Change Summary
source/_integrations/bring.markdown - Updated item data attribute description from "Article name to include in the message" to "Item to include in the message."
- Rephrased texts for "going_shopping" (to "Last chance for adjustments") and "urgent_message" (to "Attention! Attention! - We still urgently need: [Items]").
- Added note on potential differences in notification labels based on language settings and sender profiles.

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
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)
source/_integrations/bring.markdown (1)

92-92: Nitpick: Remove Excessive Blank Lines

Static analysis indicates multiple consecutive blank lines on this line. For improved readability and consistency with markdown guidelines (MD012), please reduce them to a single blank line.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

92-92: Multiple consecutive blank lines
Expected: 1; Actual: 2

(MD012, no-multiple-blanks)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4e7b0ae and 7ea261a.

📒 Files selected for processing (1)
  • source/_integrations/bring.markdown (1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/bring.markdown

92-92: Multiple consecutive blank lines
Expected: 1; Actual: 2

(MD012, no-multiple-blanks)

🔇 Additional comments (2)
source/_integrations/bring.markdown (2)

86-91: Clarify Updated Data Attribute Description

The description for the item attribute has been updated from "Article name to include in the message" to "Item to include in the message." This change improves clarity by emphasizing that any item (not just an "article") can be used. Please verify that all related documentation sections (e.g., example notifications) consistently reference the updated terminology.


95-101: Verify Updated Notification Type Texts

The texts for the notification types have been rephrased for improved clarity. In particular:

  • going_shopping now reads "I'm going shopping! - Last chance for adjustments."
  • urgent_message now reads "Attention! Attention! - We still urgently need: [Items]."

These updates provide a more direct and contextual description of each notification. Please confirm that the new wording aligns with the app’s behavior and any related notifications described later in the document.

Copy link
Contributor

@c0ffeeca7 c0ffeeca7 left a comment

Choose a reason for hiding this comment

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

Thank you, @tr4nt0r 👍

@c0ffeeca7 c0ffeeca7 merged commit c42f5cb into home-assistant:current Feb 10, 2025
3 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Feb 11, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
current This PR goes into the current branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants