Skip to content

DOCS: Add comment style guidance to CodeStyle.md #11850

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.

Sign up for GitHub

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

Open
tvegas1 wants to merge 3 commits into
base: master
Choose a base branch
from
Open

DOCS: Add comment style guidance to CodeStyle.md #11850

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
35213e9
DOCS: Add comment style guidance to CodeStyle.md
tvegas1 Aug 28, 2026
191b341
DOCS: Add comment style guidance to CodeStyle.md
tvegas1 Aug 28, 2026
8293ba4
Apply suggestion from @guy-ealey-morag
tvegas1 Aug 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Other top-level areas:

Follow these project docs instead of duplicating their contents:

- `docs/CodeStyle.md` for C/C++ formatting and naming.
- `docs/CodeStyle.md` for C/C++ formatting, naming, and comment style.
- `docs/LoggingStyle.md` for log levels and message style.
- `docs/OptimizationStyle.md` for performance-sensitive changes.
- `REVIEW.md` for UCX pull-request review checks and comment style.
10 changes: 10 additions & 0 deletions docs/CodeStyle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,16 @@
* Use `ucs_assert*` for internal invariants, not user-input validation.


## Comments
* Usually one line; use more only for a non-obvious or complex point, or
per the `## Doxygen` section below.
* Document `why` not `what`; no PR/issue references, no dev-process
Comment thread
tvegas1 marked this conversation as resolved.
Outdated
Comment thread
tvegas1 marked this conversation as resolved.
Outdated
narration.
* Document once, in the most relevant area.
* Explain locking, ownership, tradeoffs, or step-by-step processing when
non-obvious.


## Naming convention:
* Lower case, underscores
* Names must begin with ucp_/uct_/ucs_/ucm_
Expand Down