diff options
| author | Uwe Hermann <uwe@hermann-uwe.de> | 2019-12-30 17:04:17 +0100 |
|---|---|---|
| committer | Uwe Hermann <uwe@hermann-uwe.de> | 2019-12-31 16:27:28 +0100 |
| commit | b7d7e99011eb2a4bfd493bfca2f386ad9916a6a2 (patch) | |
| tree | e0763771e3edd41437c40a3ea9f8c52f0bc75508 | |
| parent | f34113a300f2866a9eae08678cdb87d8d29a8b88 (diff) | |
| download | libsigrokdecode-b7d7e99011eb2a4bfd493bfca2f386ad9916a6a2.tar.gz libsigrokdecode-b7d7e99011eb2a4bfd493bfca2f386ad9916a6a2.zip | |
HACKING: Add some Python coding style hints, fix incorrect docs.
| -rw-r--r-- | HACKING | 8 |
1 files changed, 7 insertions, 1 deletions
@@ -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. |