Skip to content

docs(esp32): Add note about including esp_check.h for error-handling.rst docs page in English (IDFGH-15271) #15930

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

tendan
Copy link
Contributor

@tendan tendan commented May 9, 2025

Description

Added note about required esp_check.h header to work with error handling macros mentioned in Error handling page. In my opinion it is useful information for people who starts working with esp-idf environment and don't do exact research through code base. Currently it is only in English, because my knowledge of Chinese is literally zero. I got down to perform commit and PR about this feature with trepidation, I've send feedback to ESP-IDF about 2 months ago, but nothing has been done in that case, even without any response.

Testing

Docs are building properly, viewed the HTML result in web browser


Checklist

Before submitting a Pull Request, please ensure the following:

  • 🚨 This PR does not introduce breaking changes.
  • All CI checks (GH Actions) pass.
  • Documentation is updated as needed.
  • Tests are updated or added as necessary.
  • Code is well-commented, especially in complex areas.
  • Git history is clean — commits are squashed to the minimum necessary.

@CLAassistant
Copy link

CLAassistant commented May 9, 2025

CLA assistant check
All committers have signed the CLA.

Copy link

github-actions bot commented May 9, 2025

Messages
📖 🎉 Good Job! All checks are passing!

👋 Hello tendan, 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 via this public GitHub repository.

This GitHub project is public mirror of our internal git repository

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 synchronize it into our internal git repository.
4. In the internal git repository 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.
5. If the change is approved and passes the tests it is merged into the default branch.
5. On next sync from the internal git repository merged change will appear in this public GitHub repository.

Generated by 🚫 dangerJS against 9ba830c

@github-actions github-actions bot changed the title docs(esp32): Add note about including esp_check.h for error-handling.rst docs page in English docs(esp32): Add note about including esp_check.h for error-handling.rst docs page in English (IDFGH-15271) May 9, 2025
@espressif-bot espressif-bot added the Status: Opened Issue is new label May 9, 2025
@KonstantinKondrashov
Copy link
Collaborator

Hi @tendan!
Thanks for contibution. It is valuable for us to know what is missing in our documentation, especially from starting users. We will update the doc.
Please sign #15930 (comment) - Contributor License Agreement is not signed yet..

@tendan
Copy link
Contributor Author

tendan commented May 9, 2025

Hi @tendan! Thanks for contibution. It is valuable for us to know what is missing in our documentation, especially from starting users. We will update the doc. Please sign #15930 (comment) - Contributor License Agreement is not signed yet..

Oh, I didn't realize that it's interactive sign. My bad, now it's done.

@KonstantinKondrashov
Copy link
Collaborator

sha=9ba830cc8a3f611d10a15bd58cf11099df62476c

@KonstantinKondrashov KonstantinKondrashov added the PR-Sync-Merge Pull request sync as merge commit label May 9, 2025
@espressif-bot espressif-bot added Status: Reviewing Issue is being reviewed and removed Status: Opened Issue is new labels May 16, 2025
@espressif-bot espressif-bot added Status: Done Issue is done internally Resolution: NA Issue resolution is unavailable Resolution: Done Issue is done internally and removed Status: Reviewing Issue is being reviewed Resolution: NA Issue resolution is unavailable labels May 23, 2025
espressif-bot pushed a commit that referenced this pull request May 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR-Sync-Merge Pull request sync as merge commit Resolution: Done Issue is done internally Status: Done Issue is done internally
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants