aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJohn Newbery <john@johnnewbery.com>2021-01-22 09:55:13 +0000
committerJohn Newbery <john@johnnewbery.com>2021-01-22 09:55:13 +0000
commitaa929abf8dc022e900755234c857541faeea8239 (patch)
tree1b334152ee9e57dd96ce978f70613fb2633d9f23 /doc
parent4bd586607d6305b828f0f554394d1c25b6dbcd14 (diff)
[docs] Update developer notes to discourage very long lines
Diffstat (limited to 'doc')
-rw-r--r--doc/developer-notes.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/developer-notes.md b/doc/developer-notes.md
index 596f65cf10..011c38321c 100644
--- a/doc/developer-notes.md
+++ b/doc/developer-notes.md
@@ -75,6 +75,11 @@ tool to clean up patches automatically before submission.
on the same line as the `if`, without braces. In every other case,
braces are required, and the `then` and `else` clauses must appear
correctly indented on a new line.
+ - There's no hard limit on line width, but prefer to keep lines to <100
+ characters if doing so does not decrease readability. Break up long
+ function declarations over multiple lines using the Clang Format
+ [AlignAfterOpenBracket](https://clang.llvm.org/docs/ClangFormatStyleOptions.html)
+ style option.
- **Symbol naming conventions**. These are preferred in new code, but are not
required when doing so would need changes to significant pieces of existing