search

home-assistant / developers.home-assistant

Developers website for Home Assistant.
https://developers.home-assistant.io
Other
304 stars 951 forks source link

Improve documentation of translation of collapsible groups in service actions #2336

Closed emontnemery closed 1 month ago

emontnemery commented 1 month ago

Proposed change

Improve documentation of translation of collapsible groups in service actions, fields can have descriptions as well as names

Type of change

Additional information

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago
:memo: Walkthrough ## Walkthrough The changes involve an update to the documentation concerning the translation of service action strings. Specifically, the documentation now includes translations for the `description` of each collapsible section of fields, alongside existing translations for the `name` and `description` of each action and its fields. This update clarifies that both the `name` and `description` for collapsible sections are supported in translation. ## Changes | File Path | Change Summary | |-----------------------------------|--------------------------------------------------------------------------------------------------------| | docs/internationalization/core.md | Updated documentation to include translations for the `description` of collapsible sections of fields. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant User participant Documentation participant TranslationService User->>Documentation: Request for service action strings Documentation->>TranslationService: Fetch translations for action names and descriptions TranslationService-->>Documentation: Return translations for names and descriptions Documentation->>TranslationService: Fetch translations for collapsible section descriptions TranslationService-->>Documentation: Return translations for collapsible section descriptions Documentation-->>User: Provide complete translated documentation ```
:scroll: Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
:inbox_tray: Commits Files that changed from the base of the PR and between a52c2ab9123f51158b09edab02a50a29e98198d4 and 711667a4be386d0376421a895ae23116cd6b9e9e.
:ledger: Files selected for processing (1) * docs/internationalization/core.md (1 hunks)
:mute: Additional comments not posted (2)
docs/internationalization/core.md (2)
`131-132`: **Excellent improvement in documentation clarity!** The addition of information about translating the `description` of collapsible sections of fields enhances the completeness of the documentation. This change aligns well with the PR objectives and provides clearer guidance on how these elements function in the translation process. --- Line range hint `1-1000`: **Overall, this is a valuable documentation improvement.** The change successfully addresses the PR objectives by enhancing the clarity of the documentation regarding the translation of collapsible groups in service actions. The modification is focused and doesn't introduce any unrelated changes, maintaining the integrity of the existing documentation.
--- 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?
:heart: Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
:placard: Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.