Update ledc.rst

[kkilchrist]

Description:

Primarily cleaned up the example by removing blocks of ######s which are not found in other YAML examples. Also edited some wording for clarity.

Related issue (if applicable): fixes

Pull request in esphome with YAML changes (if applicable): esphome/esphome#<esphome PR number goes here>

Checklist:

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

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

[netlify[bot]]

✅ Deploy Preview for esphome ready!

Name	Link
🔨 Latest commit	f131ae57fad3e9432d43a9621a64d9f1baa274d7
🔍 Latest deploy log	https://app.netlify.com/sites/esphome/deploys/6706daf904c2950008a9684b
😎 Deploy Preview	https://deploy-preview-4323--esphome.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

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

[coderabbitai[bot]]

Walkthrough

The pull request focuses on enhancing the documentation for the LED Controller (LEDC) output component in the ESP32. It clarifies the component's capabilities, improves the presentation of configuration variables, and revises example usage sections for better understanding. The document now explicitly details the operational sequence for using a piezo buzzer and refines the formatting of the recommended frequencies table. Overall, these changes aim to improve clarity and usability while retaining essential technical information.

Changes

File Path	Change Summary
components/output/ledc.rst	- Updated introduction to define LEDC as "LED Controller" and detail its capabilities.
	- Clarified frequency range and its relationship with bit depth accuracy.
	- Revised configuration variables section for clarity, including notes on multiple outputs and channel specification.
	- Improved example usage sections with specific pin assignments and IDs.
	- Expanded piezo buzzer section with clearer operational sequence instructions.
	- Refined comments in YAML examples for better readability.
	- Reformatted recommended frequencies table for improved presentation.

Possibly related PRs

• #4031: This PR refines documentation related to the Made for ESPHome program, which may include configuration aspects relevant to the LEDC output component discussed in the main PR.
• #4290: This PR adds a note regarding creating pull requests in the esphome/esphome-devices repository, which could relate to the documentation practices for components like LEDC.
• #4308: This PR updates the CSE7766 sensor documentation to include UART configuration details, which may have parallels in the configuration updates made for the LEDC output component in the main PR.

Suggested reviewers

• jesserockz
• nagyrobi

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 using 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions[bot]]

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions.