From b7d7e99011eb2a4bfd493bfca2f386ad9916a6a2 Mon Sep 17 00:00:00 2001 From: Uwe Hermann Date: Mon, 30 Dec 2019 17:04:17 +0100 Subject: HACKING: Add some Python coding style hints, fix incorrect docs. --- HACKING | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/HACKING b/HACKING index a4698a6..c5f24f5 100644 --- a/HACKING +++ b/HACKING @@ -17,6 +17,12 @@ the Python PEP-8, which includes the convention of 4 spaces for indentation: http://www.python.org/dev/peps/pep-0008/ +Exceptions: + + - All strings should use single quotes ('foo' instead of "foo"). + + - No double-newlines between methods (or anywhere else). + Contributions ------------- @@ -141,7 +147,7 @@ Protocol decoder guidelines - Longer, multi-line descriptions should be placed in the protocol decoder's __init__.py file as docstring. It can be viewed (for a specific - protocol decoder, e.g., UART) via "sigrok-cli -a uart", or in various + protocol decoder, e.g., UART) via "sigrok-cli -P uart --show", or in various other places in GUIs. - Generally use strings for states (of the PD state machine), not integers. -- cgit v1.2.3-70-g09d2