diff options
| author | Mason Simon <masonsimon@gmail.com> | 2018-07-19 12:10:03 -0700 |
|---|---|---|
| committer | Mason Simon <masonsimon@gmail.com> | 2018-07-19 12:17:00 -0700 |
| commit | a9e898a4ad547ad344671db2b942b99925f0c732 (patch) | |
| tree | 031ee126d8593f57df996e47fc206a66368dafbc /doc/developer-notes.md | |
| parent | 8c36432791652cd5a67ead6299a9611cf8fb81fa (diff) | |
docs: Link to python style guidelines from developer notes
Diffstat (limited to 'doc/developer-notes.md')
| -rw-r--r-- | doc/developer-notes.md | 16 |
1 files changed, 13 insertions, 3 deletions
diff --git a/doc/developer-notes.md b/doc/developer-notes.md index 2fa91ecb02..04b49b8b30 100644 --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -5,8 +5,10 @@ Developer Notes **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) @@ -35,8 +37,8 @@ Developer Notes <!-- markdown-toc end --> -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 @@ -46,6 +48,9 @@ commits. Do not submit patches solely to modify the style of existing code. +Coding Style (C++) +------------------ + - **Indentation and whitespace rules** as specified in [src/.clang-format](/src/.clang-format). You can use the provided [clang-format-diff script](/contrib/devtools/README.md#clang-format-diffpy) @@ -174,6 +179,11 @@ but if possible use one of the above styles. Documentation can be generated with `make docs` and cleaned up with `make clean-docs`. +Coding Style (Python) +--------------------- + +Refer to [/test/functional/README.md#style-guidelines](/test/functional/README.md#style-guidelines). + Development tips and tricks --------------------------- |