arduino-esp32
arduino-esp32 copied to clipboard
fix(docs): correct code block indentation in core_compatibility.rst
By completing this PR sufficiently, you help us to review this Pull Request quicker and also help improve the quality of Release Notes
Checklist
- [x] Please provide specific title of the PR describing the change, including the component name (eg. „Update of Documentation link on Readme.md“)
- [x] Please provide related links (eg. Issue which will be closed by this Pull Request) https://docs.espressif.com/projects/arduino-esp32/en/latest/guides/core_compatibility.html
- [x] Please update relevant Documentation if applicable
- [x] Please check Contributing guide
- [x] Please confirm option to "Allow edits and access to secrets by maintainers" when opening a Pull Request
This entire section above can be deleted if all items are checked.
Description of Change
This Pull Request fixes indentation issues in the core_compatibility.rst documentation file, specifically within .. code-block:: cpp sections. These formatting issues previously caused the code blocks to be rendered incorrectly in the generated documentation.
No functionality or logic is changed — this is a documentation-only fix.
| Messages | |
|---|---|
| :book: | 🎉 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 :no_entry_sign: dangerJS against 789258d89ba10002e555c2d5488446e570c64bbe
Hi @eMUQI, please check the issue:
en/generic: /home/runner/work/arduino-esp32/arduino-esp32/docs/en/guides/core_compatibility.rst:18: ERROR: Unexpected indentation.
Hi @eMUQI, please check the issue:
en/generic: /home/runner/work/arduino-esp32/arduino-esp32/docs/en/guides/core_compatibility.rst:18: ERROR: Unexpected indentation.
I just tested it locally and encountered the same issue:
Honestly, I'm not sure how to resolve this error because I don't think there is one.
I copied the same code block below, sphinx didn't report an error and displayed it normally.
This confuses me. I'm unsure if it's an ESP Docs or a sphinx error. I'll test it in a pure sphinx environment when I have time.
Please try this:
.. code-block:: cpp
#ifdef ESP_ARDUINO_VERSION_MAJOR
#if ESP_ARDUINO_VERSION >= ESP_ARDUINO_VERSION_VAL(3, 0, 0)
// Code for version 3.x
#else
// Code for version 2.x
#endif
#else
// Code for version 1.x
#endif