From: Vincent Pit <vince@profvince.com>
Date: Mon, 25 Oct 2010 10:08:47 +0000 (+0200)
Subject: Complete LaTeX::TikZ::Tools documentation
X-Git-Tag: rt87282~26
X-Git-Url: http://git.vpit.fr/?a=commitdiff_plain;h=eb280482bb3f811e5a3b3e1c32e2964ba26051a4;p=perl%2Fmodules%2FLaTeX-TikZ.git

Complete LaTeX::TikZ::Tools documentation
---

diff --git a/lib/LaTeX/TikZ/Tools.pm b/lib/LaTeX/TikZ/Tools.pm
index 54e5009..d2d1131 100644
--- a/lib/LaTeX/TikZ/Tools.pm
+++ b/lib/LaTeX/TikZ/Tools.pm
@@ -21,25 +21,34 @@ use Any::Moose 'Util::TypeConstraints' => [ 'find_type_constraint' ];
 
 =head2 C<EPS>
 
+The numerical accuracy enforced by L</numeq>, L</numcmp> and L</numround>.
+It is currently set to C<1e-10>.
+
 =cut
 
 use constant EPS => 1e-10;
 
 =head1 FUNCTIONS
 
-=head2 C<numeq>
+=head2 C<numeq $x, $y>
+
+Returns true if and only if C<$x> and C<$y> are equal up to L</EPS>.
 
 =cut
 
 sub numeq { abs($_[0] - $_[1]) < EPS }
 
-=head2 C<numcmp>
+=head2 C<numcmp $x, $y>
+
+Returns a negative number, zero, or a positive number when C<$x> is respectively smaller than, equal to, or greater than C<$y> up to L</EPS>.
 
 =cut
 
 sub numcmp { $_[0] < $_[1] - EPS ? -1 : $_[0] > $_[1] + EPS ? 1 : 0 }
 
-=head2 C<numround>
+=head2 C<numround $x>
+
+Returns the closest integer from C<$x> up to L</EPS>.
 
 =cut
 
@@ -51,7 +60,7 @@ sub numround {
 
 =head2 C<type_constraint $class>
 
-Find the type constraint for C<$class> by first trying to load the relevant F<.pm> file.
+Finds the type constraint for C<$class> by first trying to load the relevant F<.pm> file.
 
 =cut