-
Notifications
You must be signed in to change notification settings - Fork 7.6k
fix(docs): correct code block indentation in core_compatibility.rst #11471
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
base: master
Are you sure you want to change the base?
Conversation
👋 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 ...
Review and merge process you can expect ...
|
Hi @eMUQI, please check the issue:
|
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:
|
@@ -11,26 +11,26 @@ Code Adaptations | |||
|
|||
To ensure compatibility with both versions of the ESP32 Arduino core, developers should utilize conditional compilation directives in their code. Below is an example of how to conditionally include code based on the ESP32 Arduino core version:: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, remove the ::
from the ESP32 Arduino core version::
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the review! I tested it again — turns out the issue was caused by the extra colon (::
). Removing just one :
fixes the rendering, even with 3-space indentation. I'll update the PR accordingly.
By completing this PR sufficiently, you help us to review this Pull Request quicker and also help improve the quality of Release Notes
Checklist
https://docs.espressif.com/projects/arduino-esp32/en/latest/guides/core_compatibility.html
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.