Merge #13717: docs: Link to python style guidelines from developer notes
a9e898a4ad
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
This commit is contained in:
commit
8c3c402a5a
1 changed files with 13 additions and 3 deletions
|
@ -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
|
||||
---------------------------
|
||||
|
||||
|
|
Loading…
Reference in a new issue