Skip to content

Conversation

gapple
Copy link

@gapple gapple commented Sep 9, 2025

Description:

The * characters in the variable description were interpreted as markdown italics, but I think the description can be simplified.

Related issue (if applicable): N/A

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

  • N/A

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 /components/index.rst when creating new documents for new components or cookbook.

Cleanup max_gate_distance description
@esphome esphome bot added the current label Sep 9, 2025
adjust line breaks
Copy link
Contributor

coderabbitai bot commented Sep 9, 2025

Walkthrough

Documentation text for LD2420 sensor’s Number configuration was updated to simplify the max_gate_distance description, expressing range as approximately 12 meters and recommending a maximum value of 12, with minor punctuation edits.

Changes

Cohort / File(s) Summary
Docs: LD2420 sensor config
content/components/sensor/ld2420.md
Rewrote max_gate_distance description to remove explicit distance calculations, state ~12 m max range, and recommend a max value of 12; minor punctuation updates.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested reviewers

  • jesserockz
  • kbx81

Pre-merge checks (3 passed)

✅ Passed checks (3 passed)
Check name Status Explanation
Title Check ✅ Passed The title succinctly identifies the component (ld2420) and the specific configuration parameter (max_gate_distance) whose documentation has been updated, directly reflecting the primary change in the pull request.
Description Check ✅ Passed The description clearly explains that the change simplifies the variable description to avoid markdown italic formatting caused by asterisks, which matches the modifications made in the documentation for the max_gate_distance parameter.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.


📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7fe8285 and ddef82b.

📒 Files selected for processing (1)
  • content/components/sensor/ld2420.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**

⚙️ CodeRabbit configuration file

  • Do not generate or add any sequence diagrams

Files:

  • content/components/sensor/ld2420.md
🔇 Additional comments (1)
content/components/sensor/ld2420.md (1)

197-201: Fix numeric values, hyphens, and grammar in ld2420.md

  • Gate increments are 70 cm, so at max (15) the range ≃ 10.5 m (not 12 m); recommended max (12) ≃ 8.4 m
  • Remove the hyphen in “12-meters” and change “is specified” to “are specified”
  • Confirm these figures against the LD2420 datasheet before merging
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

Copy link

netlify bot commented Sep 9, 2025

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit cbe1fd0
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/68c0b08ecb230a0008b03dee
😎 Deploy Preview https://deploy-preview-5344--esphome.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Copy link

netlify bot commented Sep 9, 2025

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit ddef82b
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/68c0b0fff130b1000745c0b1
😎 Deploy Preview https://deploy-preview-5344--esphome.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

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