aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorHynek Schlawack <hs@ox.cx>2013-10-22 07:34:52 -0700
committerHynek Schlawack <hs@ox.cx>2013-10-22 07:34:52 -0700
commit2647636426d8a566cd1f0519cb67716e08715996 (patch)
treeae134db3174598c14934801d0c0258376591f0e8 /docs
parente524d73d76d63c6399a55cd80cec53cf39c98659 (diff)
parentf3b06cdc381fc61d37fea148e9d691338b97d1f3 (diff)
downloadcryptography-2647636426d8a566cd1f0519cb67716e08715996.tar.gz
cryptography-2647636426d8a566cd1f0519cb67716e08715996.tar.bz2
cryptography-2647636426d8a566cd1f0519cb67716e08715996.zip
Merge pull request #162 from alex/document-constructor
Document `data` parameter to the BaseHash constructor
Diffstat (limited to 'docs')
-rw-r--r--docs/primitives/cryptographic-hashes.rst4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/primitives/cryptographic-hashes.rst b/docs/primitives/cryptographic-hashes.rst
index d4dde042..aeb30f40 100644
--- a/docs/primitives/cryptographic-hashes.rst
+++ b/docs/primitives/cryptographic-hashes.rst
@@ -1,11 +1,13 @@
Message Digests
===============
-.. class:: cryptography.primitives.hashes.BaseHash
+.. class:: cryptography.primitives.hashes.BaseHash(data=None)
Abstract base class that implements a common interface for all hash
algorithms that follow here.
+ If ``data`` is provided ``update(data)`` is called upon construction.
+
.. method:: update(data)
:param bytes data: The bytes you wish to hash.