highperfocused/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-06-29 18:20:58 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Link to python style guidelines from developer notes

Browse Source
This commit is contained in:
Mason Simon
2018-07-19 12:10:03 -07:00
parent 8c36432791
commit a9e898a4ad
1 changed files with 13 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
doc/developer-notes.md
View File

@ -5,8 +5,10 @@ Developer Notes
**Table of Contents** **Table of Contents**
- [Developer Notes](#developer-notes) - [Developer Notes](#developer-notes)
- [Coding Style](#coding-style) - [Coding Style (General)](#coding-style-general)
- [Coding Style (C++)](#coding-style-c)
- [Doxygen comments](#doxygen-comments) - [Doxygen comments](#doxygen-comments)
- [Coding Style (Python)](#coding-style-python)
- [Development tips and tricks](#development-tips-and-tricks) - [Development tips and tricks](#development-tips-and-tricks)
- [Compiling for debugging](#compiling-for-debugging) - [Compiling for debugging](#compiling-for-debugging)
- [Compiling for gprof profiling](#compiling-for-gprof-profiling) - [Compiling for gprof profiling](#compiling-for-gprof-profiling)
@ -35,8 +37,8 @@ Developer Notes
<!-- markdown-toc end --> <!-- markdown-toc end -->
Coding Style Coding Style (General)
--------------- ----------------------
Various coding styles have been used during the history of the codebase, 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 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. Do not submit patches solely to modify the style of existing code.
Coding Style (C++)
------------------
- **Indentation and whitespace rules** as specified in - **Indentation and whitespace rules** as specified in
[src/.clang-format](/src/.clang-format). You can use the provided [src/.clang-format](/src/.clang-format). You can use the provided
[clang-format-diff script](/contrib/devtools/README.md#clang-format-diffpy) [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`. 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 Development tips and tricks
--------------------------- ---------------------------