Skip to content

Update coding standard for function brief documentation #4640

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

Merged
merged 1 commit into from
May 10, 2019
Merged

Update coding standard for function brief documentation #4640

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 2 additions & 0 deletions CODING_STANDARD.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,8 @@ Formatting is enforced using clang-format. For more information about this, see
functionality should remain in place for at least six months from the date of
deprecation. Before deprecating code, all in-tree uses should be replaced or
marked as deprecated.
- In the brief of function descriptions, prefer imperatives such as
`Remove first element...` over `Removes first element...`.

# Naming
- Identifiers should make clear the purpose of the thing they are naming.
Expand Down