Small docstring fix.
authorBenjamin Braatz <benjamin.braatz@graph-it.com>
Tue, 30 Mar 2021 14:11:38 +0000 (16:11 +0200)
committerBenjamin Braatz <benjamin.braatz@graph-it.com>
Tue, 30 Mar 2021 14:11:38 +0000 (16:11 +0200)
controlpi_plugins/modbus.py

index ed8d8673deb82e123f986ce40a9295f06e86aee1..2eab95b8ddd7f2cf8f06d77e0fdb9a6f35e6ea4d 100644 (file)
@@ -16,7 +16,7 @@ def crc_slow(message: bytes) -> bytes:
     the given message and this CRC is returned as two bytes (low byte
     first).
 
-    (This is the slow version without precomputed table.)
+    (This is the "slow" version without precomputed table.)
 
     >>> crc_slow(bytes([0x08, 0x01, 0x00, 0x06, 0x00, 0x06])).hex()
     '5c90'
@@ -68,6 +68,8 @@ def crc(message: bytes) -> bytes:
     the given message and this CRC is returned as two bytes (low byte
     first).
 
+    (This is the "fast" version with precomputed table.)
+
     >>> crc(bytes([0x08, 0x01, 0x00, 0x06, 0x00, 0x06])).hex()
     '5c90'
     >>> crc(bytes([0x08, 0x01, 0x01, 0x17])).hex()