From: Guido van Rossum <guido@python.org>
Date: Mon, 10 Jun 2002 19:42:43 +0000 (+0000)
Subject: Document that the key should not contain null bytes.
X-Git-Tag: v2.3c1~5393
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=a861d552c3e8925384fdeb6fdd18e5d839a36ac5;p=thirdparty%2FPython%2Fcpython.git

Document that the key should not contain null bytes.
---

diff --git a/Doc/lib/librotor.tex b/Doc/lib/librotor.tex
index e1db8eff06d3..de99b461cb43 100644
--- a/Doc/lib/librotor.tex
+++ b/Doc/lib/librotor.tex
@@ -29,7 +29,8 @@ The available functions in this module are:
 
 \begin{funcdesc}{newrotor}{key\optional{, numrotors}}
 Return a rotor object. \var{key} is a string containing the encryption key
-for the object; it can contain arbitrary binary data. The key will be used
+for the object; it can contain arbitrary binary data but not null bytes.
+The key will be used
 to randomly generate the rotor permutations and their initial positions.
 \var{numrotors} is the number of rotor permutations in the returned object;
 if it is omitted, a default value of 6 will be used.
@@ -38,7 +39,7 @@ if it is omitted, a default value of 6 will be used.
 Rotor objects have the following methods:
 
 \begin{methoddesc}[rotor]{setkey}{key}
-Sets the rotor's key to \var{key}.
+Sets the rotor's key to \var{key}. The key should not contain null bytes.
 \end{methoddesc}
 
 \begin{methoddesc}[rotor]{encrypt}{plaintext}