Skip to content

ld2420 max_gate_distance description#5344

Merged
swoboda1337 merged 4 commits intoesphome:currentfrom
gapple:patch-1
Sep 24, 2025
Merged

ld2420 max_gate_distance description#5344
swoboda1337 merged 4 commits intoesphome:currentfrom
gapple:patch-1

Conversation

@gapple
Copy link
Copy Markdown
Contributor

@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
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Sep 9, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

Documentation for the LD2420 sensor's Number configuration simplified the max_gate_distance description: removed explicit per-step distance calculations, expressed the range as approximately 12 meters, recommended a maximum value of 12, and made minor wording and punctuation edits.

Changes

Cohort / File(s) Summary
Docs: LD2420 sensor config
content/components/sensor/ld2420.md
Simplified max_gate_distance description by removing explicit 16×70 cm and 12×70 cm calculations, stating the range as ~12 m and recommending a max value of 12; minor wording and punctuation adjustments.

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.

📜 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 ddef82b and 19b671b.

📒 Files selected for processing (1)
  • content/components/sensor/ld2420.md (1 hunks)

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.

Please see the documentation for more information.

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.


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.

@netlify
Copy link
Copy Markdown

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.

@netlify
Copy link
Copy Markdown

netlify bot commented Sep 9, 2025

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit 19b671b
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/68d35de5f85dc700086c423d
😎 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.

@swoboda1337 swoboda1337 enabled auto-merge (squash) September 24, 2025 02:57
@swoboda1337 swoboda1337 merged commit 1367391 into esphome:current Sep 24, 2025
2 of 4 checks passed
SimonFischer04 pushed a commit to SimonFischer04/esphome-docs that referenced this pull request Sep 25, 2025
* Update ld2420.md

Cleanup max_gate_distance description

* Update ld2420.md

adjust line breaks

* Update content/components/sensor/ld2420.md

---------

Co-authored-by: Jonathan Swoboda <154711427+swoboda1337@users.noreply.github.com>
SimonFischer04 pushed a commit to SimonFischer04/esphome-docs that referenced this pull request Sep 25, 2025
* Update ld2420.md

Cleanup max_gate_distance description

* Update ld2420.md

adjust line breaks

* Update content/components/sensor/ld2420.md

---------

Co-authored-by: Jonathan Swoboda <154711427+swoboda1337@users.noreply.github.com>
@github-actions github-actions bot locked and limited conversation to collaborators Sep 26, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants