Skip to content

Commit 8c3c402

Browse files
committed
Merge #13717: docs: Link to python style guidelines from developer notes
a9e898a docs: Link to python style guidelines from developer notes (Mason Simon) Pull request description: Initially I moved the python style guidelines from the functional test README, but some of the python rules are test-specific, and most of the developer notes doc is C++ centric, so just dropping a link seemed better. Tree-SHA512: 9d4d5cc45526319a118595d90fcfad2c9aced22007aa096d8af04ba1b963312822804f4c15b0b227d66af49565034437691b7760e7ff6d1e3f8b10b898906362
2 parents b81a8a5 + a9e898a commit 8c3c402

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

doc/developer-notes.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,10 @@ Developer Notes
55
**Table of Contents**
66

77
- [Developer Notes](#developer-notes)
8-
- [Coding Style](#coding-style)
8+
- [Coding Style (General)](#coding-style-general)
9+
- [Coding Style (C++)](#coding-style-c)
910
- [Doxygen comments](#doxygen-comments)
11+
- [Coding Style (Python)](#coding-style-python)
1012
- [Development tips and tricks](#development-tips-and-tricks)
1113
- [Compiling for debugging](#compiling-for-debugging)
1214
- [Compiling for gprof profiling](#compiling-for-gprof-profiling)
@@ -35,8 +37,8 @@ Developer Notes
3537

3638
<!-- markdown-toc end -->
3739

38-
Coding Style
39-
---------------
40+
Coding Style (General)
41+
----------------------
4042

4143
Various coding styles have been used during the history of the codebase,
4244
and the result is not very consistent. However, we're now trying to converge to
@@ -46,6 +48,9 @@ commits.
4648

4749
Do not submit patches solely to modify the style of existing code.
4850

51+
Coding Style (C++)
52+
------------------
53+
4954
- **Indentation and whitespace rules** as specified in
5055
[src/.clang-format](/src/.clang-format). You can use the provided
5156
[clang-format-diff script](/contrib/devtools/README.md#clang-format-diffpy)
@@ -174,6 +179,11 @@ but if possible use one of the above styles.
174179

175180
Documentation can be generated with `make docs` and cleaned up with `make clean-docs`.
176181

182+
Coding Style (Python)
183+
---------------------
184+
185+
Refer to [/test/functional/README.md#style-guidelines](/test/functional/README.md#style-guidelines).
186+
177187
Development tips and tricks
178188
---------------------------
179189

0 commit comments

Comments
 (0)