diff --git a/doc/developer-notes.md b/doc/developer-notes.md --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -5,8 +5,10 @@ **Table of Contents** - [Developer Notes](#developer-notes) - - [Coding Style](#coding-style) + - [Coding Style (General)](#coding-style-general) + - [Coding Style (C++)](#coding-style-c) - [Doxygen comments](#doxygen-comments) + - [Coding Style (Python)](#coding-style-python) - [Development tips and tricks](#development-tips-and-tricks) - [Compiling for debugging](#compiling-for-debugging) - [Compiling for gprof profiling](#compiling-for-gprof-profiling) @@ -41,8 +43,8 @@ -Coding Style ---------------- +Coding Style (General) +---------------------- Various coding styles have been used during the history of the codebase, and the result is not very consistent. However, we're now trying to converge to @@ -51,6 +53,10 @@ submitting them for review. These linters are run automatically when using `arc diff` but can also be explicitly called with `arc lint`. + +Coding Style (C++) +------------------ + - Basic rules specified in [src/.clang-format](/src/.clang-format). - Braces on new lines for namespaces, classes, functions, methods. - Braces on the same line for everything else. @@ -205,6 +211,11 @@ # output goes to doc/doxygen/html/ ``` +Coding Style (Python) +--------------------- + +Refer to [functional-tests.md#style-guidelines](functional-tests.md#style-guidelines). + Development tips and tricks ---------------------------