Skip to content

Commit

Permalink
Added docs for X::Temporal::InvalidFormat
Browse files Browse the repository at this point in the history
  • Loading branch information
Jan-Olof Hendig committed May 21, 2016
1 parent 8a694d2 commit ae0a4bd
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions doc/Type/X/Temporal/InvalidFormat.pod
@@ -0,0 +1,28 @@
=begin pod
=TITLE class X::Temporal::InvalidFormat
=SUBTITLE Error due to using an invalid format when creating a DateTime or Date
class X::Temporal::InvalidFormat does X::Temporal is Exception { }
This exception is thrown when code tries to create a C<DateTime> or C<Date> object
using an invalid format.
my $dt = Date.new("12/25/2015"); # 'invalid Date string '12/25/2015'; use yyyy-mm-dd instead'
=head1 Methods
=head2 method invalid-str
Returns the invalid format string (C<12/25/2015> in the example above)
=head2 method target
Returns the target type (C<Date> in the example above)
=head2 method format
Returns valid format strings for the target type in question, (C<yyyy-mm-dd> in the example above)
=end pod

0 comments on commit ae0a4bd

Please sign in to comment.