Align exception-translations with translation requirements

[CoMPaTech]

Proposed change

Align with https://developers.home-assistant.io/docs/internationalization/core#exceptions to properly contain message (As part of #2484)

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

• New Features
  • Improved structure and clarity of exception message translations for better user understanding.
• Documentation
  • Updated documentation to reflect changes in error message formats and provide examples for implementation.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces structural changes to the exception message translations in the Home Assistant framework. Specifically, two error messages in the strings.json file have been reformatted from simple strings to objects containing a "message" key. This adjustment aims to enhance the clarity and translatability of error messages. Additionally, the implementation of the async_set_schedule function remains, demonstrating the use of the new message format when raising exceptions.

Changes

File Path	Change Summary
docs/core/integration-quality-scale/rules/exception-translations.md	Updated structure of error messages in strings.json for "end_date_before_start_date" and "cannot_connect_to_schedule". Retained example of async_set_schedule function demonstrating new message format.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant System
    participant ErrorHandler

    User->>System: Request to set schedule
    System->>ErrorHandler: Validate schedule
    alt End date before start date
        ErrorHandler-->>System: Raise ServiceValidationError
        System-->>User: Return error message (end_date_before_start_date)
    else Cannot connect to schedule
        ErrorHandler-->>System: Raise HomeAssistantError
        System-->>User: Return error message (cannot_connect_to_schedule)
    end

Loading

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

docs/core/integration-quality-scale/rules/exception-translations.md (1)

47-52: LGTM! Consider adding a note about the message structure.

The restructuring of error messages to include the "message" key aligns perfectly with Home Assistant's translation requirements. This format ensures proper internationalization support.

Consider adding a brief comment above the JSON example explaining why the messages are structured as objects with a "message" key, as this would help developers understand the reasoning behind this specific format.

 `strings.json`:
+# Error messages are structured as objects with a "message" key to support
+# consistent translation handling across Home Assistant
 ```json
 {
     "exceptions": {

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 529d1bc and 701825d.

📒 Files selected for processing (1)

• docs/core/integration-quality-scale/rules/exception-translations.md (1 hunks)

[abmantis]

Thanks!