espressif / esp-idf

Espressif IoT Development Framework. Official development framework for Espressif SoCs.
Apache License 2.0
12.56k stars 7.02k forks source link

docs: clarify ESP_RETURN_ON_ERROR result (IDFGH-12678) #13669

Closed bryghtlabs-richard closed 3 weeks ago

bryghtlabs-richard commented 3 weeks ago

Expand documentation slightly to include what ESP_RETURN_ON_ERROR returns, an esp_err_t.

I had an issue where ESP_RETURN_ON_ERROR was called in a function returning bool, and it was not immediately clear from the documentation what it should return.

github-actions[bot] commented 3 weeks ago
Messages
:book: 🎉 Good Job! All checks are passing!

👋 Hello bryghtlabs-richard, 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 :no_entry_sign: dangerJS against 4226d13b0143f9508331f88d6f3b3a4831df4f57

CLAassistant commented 3 weeks ago

CLA assistant check
All committers have signed the CLA.

Dazza0 commented 3 weeks ago

sha=4226d13b0143f9508331f88d6f3b3a4831df4f57