updated documentation for des-crypt & md5-crypt variants

7 files changed, 24 insertions, 14 deletions

diff --git a/docs/lib/passlib.hash.apr_md5_crypt.rst b/docs/lib/passlib.hash.apr_md5_crypt.rst
index 19bf621..97130a6 100644
--- a/docs/lib/passlib.hash.apr_md5_crypt.rst
+++ b/docs/lib/passlib.hash.apr_md5_crypt.rst
@@ -28,11 +28,11 @@ to the original MD5-Crypt, except for two changes:
 1. The encoded string uses ``$apr1$`` as it's prefix, while md5-crypt uses ``$1$``.
 
 2. The algorithm uses ``$apr1$`` as a constant in the step where md5-crypt uses
-   ``$1$`` in it's calculation of `digest B <md5-crypt-constant-insertion>`_.
+   ``$1$`` in it's calculation of digest B (see the :ref:`md5-crypt algorithm <md5-crypt-algorithm>`).
    Because of this change, even raw checksums generated by apr-md5-crypt and md5-crypt
    are not compatible with eachother.
 
 References
 ==========
-* `<http://httpd.apache.org/docs/2.2/misc/password_encryptions.html>`_
-  - Apache's description of Apr-MD5-Crypt can be found at
+.. [#] Apache's description of Apr-MD5-Crypt -
+       `<http://httpd.apache.org/docs/2.2/misc/password_encryptions.html>`_
diff --git a/docs/lib/passlib.hash.bigcrypt.rst b/docs/lib/passlib.hash.bigcrypt.rst
index 6a13f06..6bbbf58 100644
--- a/docs/lib/passlib.hash.bigcrypt.rst
+++ b/docs/lib/passlib.hash.bigcrypt.rst
@@ -18,7 +18,7 @@ Usage
 =====
 This class can be used in exactly the same manner as :class:`~passlib.hash.des_crypt`.
 
-Functions
+Interface
 =========
 .. autoclass:: bigcrypt(checksum=None, salt=None, strict=False)
 
@@ -134,4 +134,5 @@ This implementation of bigcrypt differs from others in two ways:
 
 References
 ==========
-* `<http://www.mail-archive.com/exim-dev@exim.org/msg00970.html>`_ - discussion of bigcrypt & crypt16
+.. [#] discussion of bigcrypt & crypt16 -
+       `<http://www.mail-archive.com/exim-dev@exim.org/msg00970.html>`_
diff --git a/docs/lib/passlib.hash.bsdi_crypt.rst b/docs/lib/passlib.hash.bsdi_crypt.rst
index 99a918e..854269b 100644
--- a/docs/lib/passlib.hash.bsdi_crypt.rst
+++ b/docs/lib/passlib.hash.bsdi_crypt.rst
@@ -136,5 +136,8 @@ This implementation of bsdi-crypt differs from others in one way:
 
 References
 ==========
-* Primary source used for description of bsdi-crypt format & algorithm - `<http://fuse4bsd.creo.hu/localcgi/man-cgi.cgi?crypt+3>`_ -
-* Another source describing algorithm - `<http://ftp.lava.net/cgi-bin/bsdi-man?proto=1.1&query=crypt&msection=3&apropos=0>`_
+.. [#] Primary source used for description of bsdi-crypt format & algorithm -
+       `<http://fuse4bsd.creo.hu/localcgi/man-cgi.cgi?crypt+3>`_
+
+.. [#] Another source describing algorithm -
+       `<http://ftp.lava.net/cgi-bin/bsdi-man?proto=1.1&query=crypt&msection=3&apropos=0>`_
diff --git a/docs/lib/passlib.hash.crypt16.rst b/docs/lib/passlib.hash.crypt16.rst
index fa4a9c2..966ecbf 100644
--- a/docs/lib/passlib.hash.crypt16.rst
+++ b/docs/lib/passlib.hash.crypt16.rst
@@ -114,4 +114,5 @@ This implementation of crypt16 deviates from public documentation of the format
 
 References
 ==========
-* One source of information about bigcrypt & crypt16 - `<http://www.mail-archive.com/exim-dev@exim.org/msg00970.html>`_ -
+.. [#] One source of information about bigcrypt & crypt16 -
+       `<http://www.mail-archive.com/exim-dev@exim.org/msg00970.html>`_
diff --git a/docs/lib/passlib.hash.des_crypt.rst b/docs/lib/passlib.hash.des_crypt.rst
index c2f2775..dd76c8b 100644
--- a/docs/lib/passlib.hash.des_crypt.rst
+++ b/docs/lib/passlib.hash.des_crypt.rst
@@ -106,7 +106,8 @@ This implementation of des-crypt differs from others in a few ways:
 * Minimum salt string:
 
   Some implementations of des-crypt allow empty and single-character salt strings.
-  However, the behavior in these cases varies wildly, including errors and broken hashes.
+  However, the behavior in these cases varies wildly between implementations,
+  including errors and broken hashes.
   To avoid all this, Passlib will throw an "invalid salt" if the provided
   salt string is not at least 2 characters.
 
@@ -133,4 +134,4 @@ This implementation of des-crypt differs from others in a few ways:
 
 References
 ==========
-* A java implementation of des-crypt, used as base for Passlib's pure-python implementation, is located at `<http://www.dynamic.net.au/christos/crypt/UnixCrypt2.txt>`_
+.. [#] A java implementation of des-crypt, used as base for Passlib's pure-python implementation, is located at `<http://www.dynamic.net.au/christos/crypt/UnixCrypt2.txt>`_
diff --git a/docs/lib/passlib.hash.md5_crypt.rst b/docs/lib/passlib.hash.md5_crypt.rst
index 7d8c292..a0e9a61 100644
--- a/docs/lib/passlib.hash.md5_crypt.rst
+++ b/docs/lib/passlib.hash.md5_crypt.rst
@@ -48,7 +48,7 @@ An md5-crypt hash string has the format ``$1${salt}${checksum}``, where:
 * ``{checksum}`` is 22 characters drawn from the same character set as the salt;
   encoding a 128-bit checksum (``azfrPr6af3Fc7dLblQXVa0`` in the example).
 
-.. _md5-crypt-constant-insertion:
+.. _md5-crypt-algorithm:
 
 .. rst-class:: html-toggle
 
@@ -168,5 +168,9 @@ Passlib's implementation of md5-crypt differs from the reference implementation
 
 References
 ==========
-.. [#f1] The official reference for MD5-Crypt is Poul-Henning Kamp's original FreeBSD implementation, located at `<http://www.freebsd.org/cgi/cvsweb.cgi/~checkout~/src/lib/libcrypt/crypt.c?rev=1.2>`_
-.. [#f2] Security issues with MD5 - `<http://en.wikipedia.org/wiki/MD5#Security>`_.
+.. [#f1] The authoritative reference for MD5-Crypt is Poul-Henning Kamp's original
+         FreeBSD implementation -
+         `<http://www.freebsd.org/cgi/cvsweb.cgi/~checkout~/src/lib/libcrypt/crypt.c?rev=1.2>`_
+
+.. [#f2] Security issues with MD5 -
+         `<http://en.wikipedia.org/wiki/MD5#Security>`_.
diff --git a/docs/lib/passlib.hash.rst b/docs/lib/passlib.hash.rst
index 464ef0e..d0dbf0b 100644
--- a/docs/lib/passlib.hash.rst
+++ b/docs/lib/passlib.hash.rst
@@ -59,7 +59,7 @@ They all follow the :ref:`modular crypt format <modular-crypt-format>` for encod
 
     These aren't fully implemented / tested yet:
 
-    * :class:`~passlib.hash.sun_md5_crypt` - MD5-based scheme used by Solaris 10 (NOT related to md5-crypt above).
+    * :doc:`passlib.hash.sun_md5_crypt <passlib.hash.sun_md5_crypt>` - MD5-based scheme used by Solaris 10 (NOT related to md5-crypt above).
 
 Non-Standard Unix-Compatible Schemes
 ------------------------------------