From: Dave Rolsky <autarch@houseabsolute.urth.org>
Date: Wed, 25 Mar 2009 19:11:38 +0000 (-0500)
Subject: Docs for Moose::Meta::TypeCoercion::Union
X-Git-Tag: 0.72_01~24
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=88463309ede3e9d6a395395ce0d6f1f5ae29cca6;p=gitmo%2FMoose.git

Docs for Moose::Meta::TypeCoercion::Union
---

diff --git a/lib/Moose/Meta/TypeCoercion/Union.pm b/lib/Moose/Meta/TypeCoercion/Union.pm
index 3d99438..a3d349d 100644
--- a/lib/Moose/Meta/TypeCoercion/Union.pm
+++ b/lib/Moose/Meta/TypeCoercion/Union.pm
@@ -59,26 +59,25 @@ Moose::Meta::TypeCoercion::Union - The Moose Type Coercion metaclass for Unions
 
 =head1 DESCRIPTION
 
-For the most part, the only time you will ever encounter an 
-instance of this class is if you are doing some serious deep 
-introspection. This API should not be considered final, but 
-it is B<highly unlikely> that this will matter to a regular 
-Moose user.
-
-If you wish to use features at this depth, please come to the 
-#moose IRC channel on irc.perl.org and we can talk :)
-
+This is a subclass of L<Moose::Meta::TypeCoercion> that is used for
+L<Moose::Meta::TypeConstraint::Union> objects.
 =head1 METHODS
 
 =over 4
 
-=item B<meta>
+=item B<< $coercion->has_coercion_for_type >>
+
+This method always returns false.
+
+=item B<< $coercion->add_type_coercions >>
 
-=item B<compile_type_coercion>
+This method always throws an error. You cannot add coercions to a
+union type constraint.
 
-=item B<has_coercion_for_type>
+=item B<< $coercion->coerce($value) >>
 
-=item B<add_type_coercions>
+This method will coerce by trying the coercions for each type in the
+union.
 
 =back