@@ -5,8 +5,10 @@ Developer Notes
5
5
** Table of Contents**
6
6
7
7
- [ Developer Notes] ( #developer-notes )
8
- - [ Coding Style] ( #coding-style )
8
+ - [ Coding Style (General)] ( #coding-style-general )
9
+ - [ Coding Style (C++)] ( #coding-style-c )
9
10
- [ Doxygen comments] ( #doxygen-comments )
11
+ - [ Coding Style (Python)] ( #coding-style-python )
10
12
- [ Development tips and tricks] ( #development-tips-and-tricks )
11
13
- [ Compiling for debugging] ( #compiling-for-debugging )
12
14
- [ Compiling for gprof profiling] ( #compiling-for-gprof-profiling )
@@ -35,8 +37,8 @@ Developer Notes
35
37
36
38
<!-- markdown-toc end -->
37
39
38
- Coding Style
39
- ---------------
40
+ Coding Style (General)
41
+ ----------------------
40
42
41
43
Various coding styles have been used during the history of the codebase,
42
44
and the result is not very consistent. However, we're now trying to converge to
@@ -46,6 +48,9 @@ commits.
46
48
47
49
Do not submit patches solely to modify the style of existing code.
48
50
51
+ Coding Style (C++)
52
+ ------------------
53
+
49
54
- ** Indentation and whitespace rules** as specified in
50
55
[ src/.clang-format] ( /src/.clang-format ) . You can use the provided
51
56
[ clang-format-diff script] ( /contrib/devtools/README.md#clang-format-diffpy )
@@ -174,6 +179,11 @@ but if possible use one of the above styles.
174
179
175
180
Documentation can be generated with ` make docs ` and cleaned up with ` make clean-docs ` .
176
181
182
+ Coding Style (Python)
183
+ ---------------------
184
+
185
+ Refer to [ /test/functional/README.md#style-guidelines] ( /test/functional/README.md#style-guidelines ) .
186
+
177
187
Development tips and tricks
178
188
---------------------------
179
189
0 commit comments