Correcting docstring format.
authorJeremy Stanley <fungi@yuggoth.org>
Fri, 18 Jun 2010 00:44:54 +0000 (00:44 +0000)
committerJeremy Stanley <fungi@yuggoth.org>
Fri, 18 Jun 2010 00:44:54 +0000 (00:44 +0000)
* lib/mudpy/password.py (create): Corrected docstring format so that
epydoc -v will run clean of errors again.

lib/mudpy/password.py

index 29fc5d9..38bfa82 100644 (file)
@@ -101,20 +101,21 @@ def create(
    separator character used to identify subsequent fields. The fields in
    order are:
 
-   1. the decimal index number indicating which algorithm was used, also
-      mapped as convenience constants at the beginning of this module
+      1. the decimal index number indicating which algorithm was used,
+         also mapped as convenience constants at the beginning of this
+         module
 
-   2. the number of times (as an exponent of 2) which the algorithm was
-      iterated, represented by a decimal value between 0 and 16
-      inclusive (0 results in one round, 16 results in 65536 rounds, and
-      anything higher than that is a potential resource consumption
-      denial of service on the application anyway)
+      2. the number of times (as an exponent of 2) which the algorithm
+         was iterated, represented by a decimal value between 0 and 16
+         inclusive (0 results in one round, 16 results in 65536 rounds,
+         and anything higher than that is a potential resource
+         consumption denial of service on the application anyway)
 
-   3. the plain-text salt with which the password was prepended before
-      hashing
+      3. the plain-text salt with which the password was prepended
+         before hashing
 
-   4. the resulting password hash itself, base64-encoded using . and /
-      as the two non-alpha-numeric characters required to reach 64
+      4. the resulting password hash itself, base64-encoded using . and
+         / as the two non-alpha-numeric characters required to reach 64
 
    The defaults provided should be safe for everyday use, but something
    more heavy-duty may be in order for admin users, such as::