Skip to content

fix(docs): Correct list indentation for analogWrite parameter #11727

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

eMUQI
Copy link
Contributor

@eMUQI eMUQI commented Aug 14, 2025

Description of Change

This pull request fixes a minor formatting issue in the analogWrite function documentation. The description for the value parameter's valid range (0 to 255) was incorrectly indented. This change corrects the indentation to ensure proper rendering and improved readability. This is a purely stylistic fix with no impact on code functionality.

Before fix:
Snipaste_2025-08-14_22-10-44

After fix:
Snipaste_2025-08-14_22-11-39

Test Scenarios

This is a documentation-only change.

Related links

https://docs.espressif.com/projects/arduino-esp32/en/latest/api/ledc.html#analogwrite

@eMUQI eMUQI requested a review from pedrominatel as a code owner August 14, 2025 14:32
Copy link
Contributor

github-actions bot commented Aug 14, 2025

Messages
📖 🎉 Good Job! All checks are passing!

👋 Hello eMUQI, we appreciate your contribution to this project!


📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

🖊️ Please also make sure you have read and signed the Contributor License Agreement for this project.

Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against b3b65b1

@lucasssvaz lucasssvaz added the Type: Documentation Issue pertains to Documentation of Arduino ESP32 label Aug 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Issue pertains to Documentation of Arduino ESP32
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants