diff options
| author | Martin Panter <vadmium+py@gmail.com> | 2016-12-24 07:44:03 (GMT) |
|---|---|---|
| committer | Martin Panter <vadmium+py@gmail.com> | 2016-12-24 07:44:03 (GMT) |
| commit | 520569e9bd9cff593f53ba3ffcbe251efd2b2344 (patch) | |
| tree | 816e606c0b42b12313ec64170b79ee87583dc5f3 /Doc | |
| parent | 3a72ee5b5a8d80bc63ba173e1fd689eab3bc3c57 (diff) | |
| parent | 3310e146cc54e7b4e76641c57272ba6c12367876 (diff) | |
| download | cpython-520569e9bd9cff593f53ba3ffcbe251efd2b2344.zip cpython-520569e9bd9cff593f53ba3ffcbe251efd2b2344.tar.gz cpython-520569e9bd9cff593f53ba3ffcbe251efd2b2344.tar.bz2 | |
Issue #29004: Merge crc_hqx() doc from 3.5
Diffstat (limited to 'Doc')
| -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 4f5f0f2..0476f50 100644 --- a/Doc/library/binascii.rst +++ b/Doc/library/binascii.rst @@ -116,8 +116,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]) |