Adjust step documentation for NumberSelector

epenet commented 4 days ago

Proposed change

Linked to https://github.com/home-assistant/core/pull/130104

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).
- [ ] I've opened up a PR to add logos and icons in Brands repository.
[x] 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: https://github.com/home-assistant/core/pull/130104
Link to parent pull request in the Brands repository:
This PR fixes or closes issue: fixes #

Checklist

[x] 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.
[x] The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

New Features
- Extensive updates to documentation for selectors in the blueprint system.
- Introduction of new configuration options, including as_int for number selectors.
- Enhanced selectors with detailed configuration options: enable_day, enable_millisecond, placeholder, no_sort, and native_name.
- Comprehensive examples added for area, device, and entity selectors.
Documentation
- Improved clarity and structure in selector documentation, including YAML examples for user guidance.

netlify[bot] commented 4 days ago

Deploy Preview for home-assistant-docs ready!

Name	Link
Latest commit	17b534ef89b6419c79ddf056e6e836a347c98b18
Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/673314caf1599200084b5452
Deploy Preview	https://deploy-preview-35650--home-assistant-docs.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

coderabbitai[bot] commented 4 days ago

📝 Walkthrough

## Walkthrough The pull request introduces extensive updates to the documentation for selectors within the blueprint system. Key enhancements include the addition of new configuration options, such as `as_int` for the number selector and various attributes for other selectors like `duration`, `icon`, `country`, and `language`. The documentation now features detailed examples and clearer guidance on expected outputs, including YAML examples, improving user understanding of selector functionalities and their configurations. ## Changes | File Path | Change Summary | |----------------------------------|-------------------------------------------------------------------------------------------------| | source/_docs/blueprint/selectors.markdown | Updated documentation to include new configuration options: `as_int` (number selector), `enable_day`, `enable_millisecond` (duration selector), `placeholder` (icon selector), `no_sort` (country and language selectors), and `native_name` (language selector). Enhanced examples and guidance for selectors like area, device, and entity. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant User participant Selector participant Documentation User->>Selector: Request selector configuration Selector->>Documentation: Retrieve updated options Documentation-->>Selector: Provide new options (e.g., as_int, enable_day) Selector-->>User: Present configuration options and examples ```

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](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)

🪧 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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

home-assistant / home-assistant.io