Documentation fixes

README

@@ -4,7 +4,7 @@ NAME
 
 VERSION
 
-    This document describes Crypt::URandom version 0.40
+    This document describes Crypt::URandom version 0.41_02
 
 SYNOPSIS
 
@@ -31,18 +31,20 @@ SUBROUTINES/METHODS
     urandom
 
       This function accepts an integer and returns a string of the same
-      size filled with random data. The first call will initialize the
-      native cryptographic libraries (if necessary) and load all the
-      required Perl libraries. This call is a buffered read on non Win32
-      platforms that do not support getrandom(2) or equivalent.
+      size filled with random data. It will throw an exception if the
+      requested amount of random data is not returned. The first call will
+      initialize the native cryptographic libraries (if necessary) and load
+      all the required Perl libraries. This call is a buffered read on non
+      Win32 platforms that do not support getrandom(2) or equivalent.
 
     urandom_ub
 
       This function accepts an integer and returns a string of the same
-      size filled with random data. The first call will initialize the
-      native cryptographic libraries (if necessary) and load all the
-      required Perl libraries. This call is a unbuffered sysread on non
-      Win32 platforms that do not support getrandom(2) or equivalent.
+      size filled with random data. It will throw an exception if the
+      requested amount of random data is not returned. The first call will
+      initialize the native cryptographic libraries (if necessary) and load
+      all the required Perl libraries. This call is a unbuffered sysread on
+      non Win32 platforms that do not support getrandom(2) or equivalent.
 
 DIAGNOSTICS
 

README.md

@@ -4,7 +4,7 @@ Crypt::URandom - Provide non blocking randomness
 
 # VERSION
 
-This document describes Crypt::URandom version 0.40
+This document describes Crypt::URandom version 0.41\_02
 
 # SYNOPSIS
 
@@ -23,26 +23,28 @@ OR
 This Module is intended to provide
 an interface to the strongest available source of non-blocking 
 randomness on the current platform.  Platforms currently supported are
-anything supporting getrandom(2), /dev/urandom and versions of Windows greater
+anything supporting [getrandom(2)](http://man.he.net/man2/getrandom), /dev/urandom and versions of Windows greater
 than or equal to Windows 2000.
 
 # SUBROUTINES/METHODS
 
 - `urandom`
 
     This function accepts an integer and returns a string of the same size
-    filled with random data.  The first call will initialize the native
+    filled with random data. It will throw an exception if the requested amount of
+    random data is not returned. The first call will initialize the native
     cryptographic libraries (if necessary) and load all the required Perl libraries.
-    This call is a buffered read on non Win32 platforms that do not support getrandom(2)
+    This call is a buffered read on non Win32 platforms that do not support [getrandom(2)](http://man.he.net/man2/getrandom)
     or equivalent.
 
 - `urandom_ub`
 
     This function accepts an integer and returns a string of the same size
-    filled with random data.  The first call will initialize the native
+    filled with random data.  It will throw an exception if the requested amount of
+    random data is not returned.  The first call will initialize the native
     cryptographic libraries (if necessary) and load all the required Perl libraries.
     This call is a unbuffered sysread on non Win32 platforms that do not support
-    getrandom(2) or equivalent.
+    [getrandom(2)](http://man.he.net/man2/getrandom) or equivalent.
 
 # DIAGNOSTICS
 

lib/Crypt/URandom.pm

@@ -249,7 +249,7 @@ OR
 This Module is intended to provide
 an interface to the strongest available source of non-blocking 
 randomness on the current platform.  Platforms currently supported are
-anything supporting getrandom(2), /dev/urandom and versions of Windows greater
+anything supporting L<getrandom(2)>, /dev/urandom and versions of Windows greater
 than or equal to Windows 2000.
 
 =head1 SUBROUTINES/METHODS
@@ -258,23 +258,25 @@ than or equal to Windows 2000.
 
 =item C<urandom>
 
-=for stopwords cryptographic
+=for stopwords cryptographic Win32 initialize
 
 This function accepts an integer and returns a string of the same size
-filled with random data.  The first call will initialize the native
+filled with random data. It will throw an exception if the requested amount of
+random data is not returned. The first call will initialize the native
 cryptographic libraries (if necessary) and load all the required Perl libraries.
-This call is a buffered read on non Win32 platforms that do not support getrandom(2)
+This call is a buffered read on non Win32 platforms that do not support L<getrandom(2)>
 or equivalent.
 
 =item C<urandom_ub>
 
-=for stopwords cryptographic
+=for stopwords cryptographic Win32 initialize unbuffered sysread
 
 This function accepts an integer and returns a string of the same size
-filled with random data.  The first call will initialize the native
+filled with random data.  It will throw an exception if the requested amount of
+random data is not returned.  The first call will initialize the native
 cryptographic libraries (if necessary) and load all the required Perl libraries.
 This call is a unbuffered sysread on non Win32 platforms that do not support
-getrandom(2) or equivalent.
+L<getrandom(2)> or equivalent.
 
 =back