Clarify how to make an add-on option optional

agners commented 1 month ago

Proposed change

The options and schema behavior is a bit intertwined when it comes to optional values. This is probably because the schema came later and is still optional today.

Make it clear what is necessary to make an option truly optional.

Type of change

[x] 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

Documentation
- Clarified the usage of the options and schema dictionaries for defining mandatory and optional options in add-ons.
- Enhanced explanations to prevent confusion about categorizing options as required or optional.

coderabbitai[bot] commented 1 month ago

Walkthrough

## Walkthrough The documentation has been updated to clarify the use of the `options` and `schema` dictionaries in defining mandatory and optional settings for add-ons. Key distinctions have been made about how to correctly categorize options based on their default values and schema definitions. This enhances user understanding of configuration requirements, especially concerning nested structures. ## Changes | Files | Change Summary | |----------------------------------|-------------------------------------------------------------------------------| | docs/add-ons/configuration.md | Clarified usage of `options` and `schema` dictionaries for mandatory/optional options. Emphasized distinctions for nested structures to reduce confusion. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant User participant Options participant Schema User->>Options: Define option with default value Options->>Schema: Check if option is mandatory Schema-->>Options: Return mandatory status Options->>User: Confirm option status (mandatory/optional) ```

Recent review details

**Configuration used: CodeRabbit UI** **Review profile: CHILL**

Commits

Files that changed from the base of the PR and between 9f616cd5d710f9935af79a33aa093ccd4105b982 and f8b889f64edf23282cc31091e9b9b0610881395f.

Files selected for processing (1)

* docs/add-ons/configuration.md (1 hunks)

Additional context used

LanguageTool

docs/add-ons/configuration.md
[uncategorized] ~203-~203: Possible missing comma found. Context: ...onary to make an option mandatory. This way the option needs to be given by the use... (AI_HYDRA_LEO_MISSING_COMMA)

Additional comments not posted (1)

docs/add-ons/configuration.md (1)
`205-205`: **LGTM!** The explanation of making an option truly optional using the `schema` dictionary is clear and concise.

--- 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 .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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.

agners commented 1 month ago

Note that the somewhat strange combination of:

options:
  test: null
schema:
  test: str?

Is valid from a Supervisor/backend perspective. This essentially means by default we ask the user to provide a value for test, but if the user doesn't want to provide (e.g. wants to opt-out), he can do so.

This is not (well) supported by the frontend. You can opt-out of providing test by deleting the option (test: null) in YAML mode, which correctly saves that config. But the frontend fills the default value back in. So you have to remove the config option every time.

home-assistant / developers.home-assistant