]> sigrok.org Git - libsigrokdecode.git/commitdiff
sdq: provide more information in the decoder's boilerplate
authorGerhard Sittig <redacted>
Wed, 12 Aug 2020 16:48:27 +0000 (18:48 +0200)
committerGerhard Sittig <redacted>
Wed, 12 Aug 2020 18:18:10 +0000 (20:18 +0200)
Extend the __init__.py module's doc string. Provide more details to the
user beyond the vendor's name, to increase the decoder's usability.

decoders/sdq/__init__.py

index 7087bdabfe4a867dd8b7319e3e2b697d2a2262ee..3fc10438b45e3ac95b9ff00da182183cdac8c6e1 100644 (file)
 ##
 
 '''
-Texas Instruments SDQ protocol, also used by Apple.
+The SDQ protocol was developed by Texas Instruments, and is used in
+devices like battery pack authentication. Apple uses SDQ in MagSafe
+and Lightning connectors, as well as some batteries.
+
+See https://www.ti.com/lit/ds/symlink/bq26100.pdf for details.
 '''
 
 from .pd import Decoder