From aa929abf8dc022e900755234c857541faeea8239 Mon Sep 17 00:00:00 2001 From: John Newbery Date: Fri, 22 Jan 2021 09:55:13 +0000 Subject: [docs] Update developer notes to discourage very long lines --- doc/developer-notes.md | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'doc/developer-notes.md') 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 -- cgit v1.2.3