-
Notifications
You must be signed in to change notification settings - Fork 133
Update clangd documentation #1198
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
Conversation
WalkthroughThe documentation has been updated with a new section in the FAQs that explains why old C/C++ editor formatter files (.xml) are not compatible with current ESP-IDF projects. It details how ESP-IDF now relies on Clangd and the need for a Changes
Possibly related PRs
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
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.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/en/faqs.rst (2)
173-176: Appropriate Code Block for Command Usage.
The use of the.. code-block:: nonedirective to present the command is clear. For enhanced readability, consider switching to a shell-specific code block (e.g.,.. code-block:: bash) to benefit from syntax highlighting.
183-187: Polish Bullet List Formatting for Replicating Old Settings.
The bulleted list offers practical options for users who want to replicate their old formatter settings. To improve readability, consider revising the line:
- From: "Or Use an AI tool(e.g: ChatGPT) to assist in converting your old configuration to the new one and then manually adjust if there are any discrepancies."
- To: "Or use an AI tool (e.g., ChatGPT) to assist in converting your old configuration to the new format and then manually adjust for any discrepancies."
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/en/faqs.rst(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: build_macos
🔇 Additional comments (4)
docs/en/faqs.rst (4)
167-168: New FAQ Entry Title & Underline Formatting Correct.
The new FAQ question is clearly stated and the underline (using dashes) follows RST conventions well.
169-172: Clear Explanation of Incompatibility and Suggested Action.
The text effectively explains that the old.xml(CDT formatter) files cannot be used with ESP-IDF projects now relying on Clangd, and it guides users on generating a default.clang-formatfile. This section is concise and aligns with the documentation’s tone.
177-182: Clear Differentiation Between New and Existing Projects.
The instructions clearly delineate that in new ESP-IDF projects the.clang-formatfile is auto-generated while for existing projects it must be created manually (via “ESP-IDF > Create Clangd File”). This provides users with straightforward guidance depending on their project type.
188-189: Valuable External References Provided.
The inclusion of links to the Clang Format documentation and formatting style options will help users seeking more detailed guidance.
Description
Documenation update based on the users request
Type of change
Checklist
Summary by CodeRabbit