Merge pull request #183 from jezdez/patch-1

Fixed internal rST reference in secret documentation
pyca · Apr 25, 2016 · 8621244 · 8621244
2 parents 14e67dc + 5825419
commit 8621244
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/docs/secret.rst b/docs/secret.rst
@@ -81,7 +81,7 @@ reason, many protocols derive a new key for each session, reset the counter
 to zero with each new key, and never store the derived key or the counter.
 
 You can safely generate random nonces by calling
-:class:``~nacl.utils.random(SecretBox.NONCE_SIZE)``.
+:func:`~nacl.utils.random(SecretBox.NONCE_SIZE)`.
 
 
 Reference

diff --git a/docs/utils.rst b/docs/utils.rst
@@ -1,5 +1,7 @@
-Utility Classes
-===============
+Utilities
+=========
+
+.. currentmodule:: nacl.utils
 
 .. class:: EncryptedMessage
 
@@ -15,3 +17,10 @@ Utility Classes
     .. attribute:: ciphertext
 
         The ciphertext contained within the :class:`EncryptedMessage`.
+
+.. function:: random(size=32)
+
+    Returns a random bytestring with the given ``size``.
+
+    :param bytes size: The size of the random bytestring.
+    :return bytes: The random bytestring.