diff options
| author | Barry Warsaw <barry@python.org> | 1996-12-23 23:34:17 (GMT) |
|---|---|---|
| committer | Barry Warsaw <barry@python.org> | 1996-12-23 23:34:17 (GMT) |
| commit | f308c0f1fc079189b5d3b27ef86e0e27a5c9ac42 (patch) | |
| tree | 970720968c295b757c73696a63c9ace25f92bbb4 | |
| parent | f3dd5aab2f41868186703388fa170517eb000258 (diff) | |
| download | cpython-f308c0f1fc079189b5d3b27ef86e0e27a5c9ac42.zip cpython-f308c0f1fc079189b5d3b27ef86e0e27a5c9ac42.tar.gz cpython-f308c0f1fc079189b5d3b27ef86e0e27a5c9ac42.tar.bz2 | |
From reading the source, it turns out that the setkey() method can
take an optional string key, but if key is not given, the method does
nothing! In the rewrite (see upcoming check-in), I left things this
way, but here I document that this is the case.
| -rw-r--r-- | Doc/lib/librotor.tex | 5 | ||||
| -rw-r--r-- | Doc/librotor.tex | 5 |
2 files changed, 6 insertions, 4 deletions
diff --git a/Doc/lib/librotor.tex b/Doc/lib/librotor.tex index 6befb05..af2a283 100644 --- a/Doc/lib/librotor.tex +++ b/Doc/lib/librotor.tex @@ -35,8 +35,9 @@ if it is omitted, a default value of 6 will be used. Rotor objects have the following methods: \renewcommand{\indexsubitem}{(rotor method)} -\begin{funcdesc}{setkey}{} -Reset the rotor to its initial state. +\begin{funcdesc}{setkey}{\optional{key}} +Sets the rotor's key to \var{key}. If \var{key} is not given, this +function does nothing\footnote{This is for backwards compatibility.}. \end{funcdesc} \begin{funcdesc}{encrypt}{plaintext} diff --git a/Doc/librotor.tex b/Doc/librotor.tex index 6befb05..af2a283 100644 --- a/Doc/librotor.tex +++ b/Doc/librotor.tex @@ -35,8 +35,9 @@ if it is omitted, a default value of 6 will be used. Rotor objects have the following methods: \renewcommand{\indexsubitem}{(rotor method)} -\begin{funcdesc}{setkey}{} -Reset the rotor to its initial state. +\begin{funcdesc}{setkey}{\optional{key}} +Sets the rotor's key to \var{key}. If \var{key} is not given, this +function does nothing\footnote{This is for backwards compatibility.}. \end{funcdesc} \begin{funcdesc}{encrypt}{plaintext} |