All PDs: More consistent OUTPUT_PYTHON format docs.

diff --git a/decoders/i2c/pd.py b/decoders/i2c/pd.py
index a8a222687d9ac8792315acadcbeaf3726a2e4465..2d6e5c2986bdf26d1ca54b0e9cc23641dfc58a2b 100644 (file)
--- a/decoders/i2c/pd.py
+++ b/decoders/i2c/pd.py
@@ -28,10 +28,10 @@ import sigrokdecode as srd
 '''
 OUTPUT_PYTHON format:
 
-I²C packet:
-[<cmd>, <data>]
+Packet:
+[<ptype>, <pdata>]
 
-<cmd> is one of:
+<ptype>:
  - 'START' (START condition)
  - 'START REPEAT' (Repeated START condition)
  - 'ADDRESS READ' (Slave address, read)
@@ -41,12 +41,12 @@ I²C packet:
  - 'STOP' (STOP condition)
  - 'ACK' (ACK bit)
  - 'NACK' (NACK bit)
- - 'BITS' (<data>: list of data/address bits and their ss/es numbers)
+ - 'BITS' (<pdata>: list of data/address bits and their ss/es numbers)
 
-<data> is the data or address byte associated with the 'ADDRESS*' and 'DATA*'
+<pdata> is the data or address byte associated with the 'ADDRESS*' and 'DATA*'
 command. Slave addresses do not include bit 0 (the READ/WRITE indication bit).
 For example, a slave address field could be 0x51 (instead of 0xa2).
-For 'START', 'START REPEAT', 'STOP', 'ACK', and 'NACK' <data> is None.
+For 'START', 'START REPEAT', 'STOP', 'ACK', and 'NACK' <pdata> is None.
 '''
 
 # CMD: [annotation-type-index, long annotation, short annotation]

diff --git a/decoders/jtag/pd.py b/decoders/jtag/pd.py
index 95e5d28c5fc364da1f4ea123360af25220e4fe08..25f26342183ba14bebc181fbeffeb85d4616ee58 100644 (file)
--- a/decoders/jtag/pd.py
+++ b/decoders/jtag/pd.py
@@ -23,11 +23,11 @@ import sigrokdecode as srd
 '''
 OUTPUT_PYTHON format:
 
-JTAG packet:
-[<packet-type>, <data>]
+Packet:
+[<ptype>, <pdata>]
 
-<packet-type> is one of:
- - 'NEW STATE': <data> is the new state of the JTAG state machine.
+<ptype>:
+ - 'NEW STATE': <pdata> is the new state of the JTAG state machine.
    Valid values: 'TEST-LOGIC-RESET', 'RUN-TEST/IDLE', 'SELECT-DR-SCAN',
    'CAPTURE-DR', 'SHIFT-DR', 'EXIT1-DR', 'PAUSE-DR', 'EXIT2-DR', 'UPDATE-DR',
    'SELECT-IR-SCAN', 'CAPTURE-IR', 'SHIFT-IR', 'EXIT1-IR', 'PAUSE-IR',

diff --git a/decoders/spi/pd.py b/decoders/spi/pd.py
index 7250dbd518eedec23f2c4afd52879c4f3dba74df..5bab8f75f16c4d305e08b4937deb57b1be44791f 100644 (file)
--- a/decoders/spi/pd.py
+++ b/decoders/spi/pd.py
@@ -24,10 +24,10 @@ import sigrokdecode as srd
 '''
 OUTPUT_PYTHON format:
 
-SPI packet:
-[<cmd>, <data1>, <data2>]
+Packet:
+[<ptype>, <data1>, <data2>]
 
-Commands:
+<ptype>:
  - 'DATA': <data1> contains the MISO data, <data2> contains the MOSI data.
    The data is _usually_ 8 bits (but can also be fewer or more bits).
    Both data items are Python numbers (not strings), or None if the respective

diff --git a/decoders/uart/pd.py b/decoders/uart/pd.py
index a0b13268301611ee654a903d979f922a95d21e3b..ae99874c8f48762cfb10396d22e96bc03dcf09d4 100644 (file)
--- a/decoders/uart/pd.py
+++ b/decoders/uart/pd.py
@@ -23,10 +23,10 @@ import sigrokdecode as srd
 '''
 OUTPUT_PYTHON format:
 
-UART packet:
-[<packet-type>, <rxtx>, <packet-data>]
+Packet:
+[<ptype>, <rxtx>, <pdata>]
 
-This is the list of <packet-type>s and their respective <packet-data>:
+This is the list of <ptype>s and their respective <pdata> values:
  - 'STARTBIT': The data is the (integer) value of the start bit (0/1).
  - 'DATA': The data is the (integer) value of the UART data. Valid values
    range from 0 to 512 (as the data can be up to 9 bits in size).