uart: document the Python annotation for BREAK

[libsigrokdecode.git] / decoders / uart / pd.py

diff --git a/decoders/uart/pd.py b/decoders/uart/pd.py
index ffacad9acfb6c83c65058b59a4cbda159d6a2b01..2ba8c57f70c4fa92e47a1df0a1b2c0a1868fd239 100644 (file)
--- a/decoders/uart/pd.py
+++ b/decoders/uart/pd.py
@@ -40,6 +40,7 @@ This is the list of <ptype>s and their respective <pdata> values:
  - 'PARITY ERROR': The data is a tuple with two entries. The first one is
    the expected parity value, the second is the actual parity value.
  - TODO: Frame error?
+ - 'BREAK': The data is always 0.
 
 The <rxtx> field is 0 for RX packets, 1 for TX packets.
 '''