Skip to content

[select] describe options parameter#6784

Open
ssieb wants to merge 1 commit into
currentfrom
ssieb-patch-2
Open

[select] describe options parameter#6784
ssieb wants to merge 1 commit into
currentfrom
ssieb-patch-2

Conversation

@ssieb

@ssieb ssieb commented Jun 13, 2026

Copy link
Copy Markdown
Member

Description

Related issue (if applicable): fixes

Pull request in esphome with YAML changes (if applicable):

  • esphome/esphome#

Checklist

  • I am merging into next because this is new documentation that has a matching pull-request in esphome as linked above.
    or

  • I am merging into current because this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.

  • Link added in /src/content/docs/components/index.mdx when creating new documents for new components or cookbook.

New Component Images

If you are adding a new component to ESPHome, you can automatically generate a standardized black and white component name image for the documentation.

To generate a component image:

  1. Comment on this pull request with the following command, replacing component_name with your component name in lower_case format with underscores (e.g., bme280, sht3x, dallas_temp):

    @esphomebot generate image component_name
    
  2. The ESPHome bot will respond with a downloadable ZIP file containing the SVG image.

  3. Extract the SVG file and place it in the /public/images/ folder of this repository.

  4. Use the image in your component's index table entry in /src/content/docs/components/index.mdx.

Example: For a component called "DHT22 Temperature Sensor", use:

@esphomebot generate image dht22

Note: All images used in ImgTable components must be placed in /public/images/ as the component resolves them to absolute paths.

@esphome esphome Bot added the current label Jun 13, 2026
@netlify

netlify Bot commented Jun 13, 2026

Copy link
Copy Markdown

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit e7e372e
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/6a2da07632f45b00081f1e5b
😎 Deploy Preview https://deploy-preview-6784--esphome.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

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

@coderabbitai

coderabbitai Bot commented Jun 13, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: e6da2a21-727f-44a2-a904-7a4494f8e4cf

📥 Commits

Reviewing files that changed from the base of the PR and between 8d80860 and e7e372e.

📒 Files selected for processing (1)
  • src/content/docs/components/select/index.mdx

Walkthrough

Documentation for the select component's options configuration variable was added to the base configuration section, directing readers to platform-specific documentation for details about allowable option values.

Changes

Select Component Documentation

Layer / File(s) Summary
Options configuration variable documentation
src/content/docs/components/select/index.mdx
New configuration variable entry documents the options field as selectable options with a link to platform-specific documentation for allowed values.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title '[select] describe options parameter' directly and specifically describes the main change—documenting the options parameter for the select component.
Description check ✅ Passed The description indicates this is a documentation fix for the current branch, and the PR objectives confirm the PR updates documentation for the select component's options parameter.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch ssieb-patch-2

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant