[ld2420] add missing docs and add docs for startup_delay#6427
[ld2420] add missing docs and add docs for startup_delay#6427jharris4 wants to merge 1 commit intoesphome:currentfrom
Conversation
WalkthroughUpdated the ld2420 platform configuration documentation by replacing a single required entry with three documented optional configuration parameters: Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
src/content/docs/components/sensor/ld2420.mdx (1)
118-118: Clarifystartup_delaydefault with an explicit time unit.
startup_delayis typed as [Time], so “defaults to zero” is slightly ambiguous. Consider usingDefaults to \0s`` for consistency and clarity.✏️ Suggested wording tweak
-- **startup_delay** (*Optional*, [Time](/guides/configuration-types#time)): An optional startup delay - defaults to zero. +- **startup_delay** (*Optional*, [Time](/guides/configuration-types#time)): Optional startup delay before initialization. Defaults to `0s`.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/components/sensor/ld2420.mdx` at line 118, The doc line for the config field startup_delay is ambiguous because it omits a time unit; update the description for startup_delay (in the sensor component docs) to explicitly show the time unit, e.g., "Defaults to `0s`" or similar so it reads: startup_delay (Optional, [Time]): An optional startup delay — defaults to 0s; keep the [Time] type reference and formatting consistent with other Time defaults.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@src/content/docs/components/sensor/ld2420.mdx`:
- Line 118: The doc line for the config field startup_delay is ambiguous because
it omits a time unit; update the description for startup_delay (in the sensor
component docs) to explicitly show the time unit, e.g., "Defaults to `0s`" or
similar so it reads: startup_delay (Optional, [Time]): An optional startup delay
— defaults to 0s; keep the [Time] type reference and formatting consistent with
other Time defaults.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 1c1e8b14-05e0-4e40-9a8e-2a7d79562ba9
📒 Files selected for processing (1)
src/content/docs/components/sensor/ld2420.mdx
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Description
Related issue (if applicable): fixes
Pull request in esphome with YAML changes (if applicable):
Checklist
I am merging into
nextbecause this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
currentbecause 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.mdxwhen 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:
Comment on this pull request with the following command, replacing
component_namewith your component name in lower_case format with underscores (e.g.,bme280,sht3x,dallas_temp):The ESPHome bot will respond with a downloadable ZIP file containing the SVG image.
Extract the SVG file and place it in the
/public/images/folder of this repository.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:
Note: All images used in ImgTable components must be placed in
/public/images/as the component resolves them to absolute paths.