diff options
| author | Martin Panter <vadmium+py@gmail.com> | 2016-12-24 07:36:44 (GMT) |
|---|---|---|
| committer | Martin Panter <vadmium+py@gmail.com> | 2016-12-24 07:36:44 (GMT) |
| commit | 3310e146cc54e7b4e76641c57272ba6c12367876 (patch) | |
| tree | 767f4f38eaf518e9cf4adf7e085f8b44d55996b6 /Doc/library/binascii.rst | |
| parent | 972e04ec4666746dc8a441449aa5b63f89af5b98 (diff) | |
| download | cpython-3310e146cc54e7b4e76641c57272ba6c12367876.zip cpython-3310e146cc54e7b4e76641c57272ba6c12367876.tar.gz cpython-3310e146cc54e7b4e76641c57272ba6c12367876.tar.bz2 | |
Issue #29004: Document binascii.crc_hqx() implements CRC-CCITT
Diffstat (limited to 'Doc/library/binascii.rst')
| -rw-r--r-- | Doc/library/binascii.rst | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/Doc/library/binascii.rst b/Doc/library/binascii.rst index 878d8db..49da59a 100644 --- a/Doc/library/binascii.rst +++ b/Doc/library/binascii.rst @@ -115,8 +115,10 @@ The :mod:`binascii` module defines the following functions: .. function:: crc_hqx(data, value) - Compute the binhex4 crc value of *data*, starting with *value* as the - initial crc, and return the result. + Compute a 16-bit CRC value of *data*, starting with *value* as the + initial CRC, and return the result. This uses the CRC-CCITT polynomial + *x*:sup:`16` + *x*:sup:`12` + *x*:sup:`5` + 1, often represented as + 0x1021. This CRC is used in the binhex4 format. .. function:: crc32(data[, value]) |