aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorlloyd <[email protected]>2015-03-10 13:17:22 +0000
committerlloyd <[email protected]>2015-03-10 13:17:22 +0000
commitae23641ce0531e77b77d660873de1c2e374d21d0 (patch)
tree3437c84def6186e1cdd8edd7ec9e578be80ef57a /doc
parent45c6dcf839e6b2e701db6c9158dc890cb8be36a2 (diff)
Use /usr/bin/env to find python in the install script, Python doc updates
Both from Uri B to mailing list.
Diffstat (limited to 'doc')
-rw-r--r--doc/manual/python.rst17
1 files changed, 10 insertions, 7 deletions
diff --git a/doc/manual/python.rst b/doc/manual/python.rst
index 295caa3c3..cef9fddd2 100644
--- a/doc/manual/python.rst
+++ b/doc/manual/python.rst
@@ -109,7 +109,8 @@ Ciphers
.. py:method:: update_granularity()
- Returns update block size
+ Returns update block size. Call to update() must provide
+ input of exactly this many bytes
.. py:method:: is_authenticated()
@@ -134,15 +135,17 @@ Ciphers
.. py:method:: update(txt)
- Consumes input text and returns output
+ Consumes input text and returns output. Input text must be
+ of update_granularity() length. Alternately, always call
+ finish with the entire message, avoiding calls to update
+ entirely
.. py:method:: finish(txt = None)
- Finish processing (with an optional final input). May throw if
- message authentication checks fail, in which case all plaintext
- previously processed must be discarded. Alternately, always
- call finish with the entire message, avoiding calls to update
- entirely.
+ Finish processing (with an optional final input). May throw
+ if message authentication checks fail, in which case all
+ plaintext previously processed must be discarded. You may
+ call finish() with the entire message
Bcrypt
----------------------------------------