Clarify compact C++ formatting guidance - #5874
softhack007 with Copilot wants to merge 6 commits into
Conversation
Co-authored-by: softhack007 <91616163+softhack007@users.noreply.github.com>
Co-authored-by: softhack007 <91616163+softhack007@users.noreply.github.com>
Co-authored-by: softhack007 <91616163+softhack007@users.noreply.github.com>
|
Important Review skippedBot user detected. To trigger a single review, invoke the ⚙️ Run configurationConfiguration used: Repository: wled/WLED/.coderabbit.yaml Review profile: CHILL Plan: Advanced Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
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. Comment |
|
@coderabbitai full review |
|
@coderabbitai review |
* bad: each parameter on a separate line * good: avoid re-phrasing the source code
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
The documentation-only changes are consistent, clear, and aligned with the stated purpose.
Review effort: Balanced
Findings: None
What changed in this PR
Clarifies WLED’s preferred compact C++ formatting for function parameters and conditional expressions.
Changes:
- Documents compact formatting with good and bad examples.
- Aligns contributor, C++ review, and agent guidance.
| File | Description |
|---|---|
CONTRIBUTING.md |
Adds formatting guidance and examples. |
docs/cpp.instructions.md |
Adds the C++ formatting rule. |
AGENTS.md |
Aligns agent instructions with contributor guidance. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
PR closed by accident 😅 |
|
@coderabbitai are you there? |
This is a clarification for contributors, to explain that we prefer "all parameters on the same line" for source code readability.
(based on some extreme examples in #5833)
ifconditions; allow multiline parameters when lists are very long.CONTRIBUTING.md, positioned immediately before the Comments guidelines.AGENTS.md.AI assistance: yes. for writing up everything into concise statements.