Skip to content

Commit 73be2ed

Browse files
author
Joel Allred
authored
Merge pull request #4640 from allredj/imperative-comments
Update coding standard for function brief documentation
2 parents 6364659 + 3a163fd commit 73be2ed

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

CODING_STANDARD.md

+2
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,8 @@ Formatting is enforced using clang-format. For more information about this, see
121121
functionality should remain in place for at least six months from the date of
122122
deprecation. Before deprecating code, all in-tree uses should be replaced or
123123
marked as deprecated.
124+
- In the brief of function descriptions, prefer imperatives such as
125+
`Remove first element...` over `Removes first element...`.
124126
125127
# Naming
126128
- Identifiers should make clear the purpose of the thing they are naming.

0 commit comments

Comments
 (0)