| Subject: | Correct some misstatements in the docs, and fix some minor wording problems |
A few places in the docs were incorrect in stating what formats are supported and/or emitted by the code. I fixed the ones that I saw.
Note that ISO 8601 specifies a whole slew's worth of grammar for dates, times, datetimes, durations, intervals, and repeating intervals, and I wanted to make it clear that DateTime::Tiny doesn't support the whole range of ISO 8601.
While I was changing things in the docs, I also fixed a couple of spelling things.
This patch applies after the other one I just submitted, so you might get fuzz unless you apply that one first.
| Subject: | 0001-Correct-some-misstatements-in-the-docs-and-fix-some-.patch |
From af636a13a5035f8a73ceb00cf9b3a996a8b01285 Mon Sep 17 00:00:00 2001
From: Ken Williams <Ken.Williams@WindLogics.com>
Date: Tue, 7 May 2013 17:55:02 -0500
Subject: [PATCH] Correct some misstatements in the docs, and fix some minor
wording problems.
---
lib/DateTime/Tiny.pm | 22 ++++++++++++----------
1 files changed, 12 insertions(+), 10 deletions(-)
diff --git a/lib/DateTime/Tiny.pm b/lib/DateTime/Tiny.pm
index 58b3f61..5c61c68 100644
--- a/lib/DateTime/Tiny.pm
+++ b/lib/DateTime/Tiny.pm
@@ -84,14 +84,14 @@ To make up for this, B<if> you have L<DateTime> installed, any
B<DateTime::Tiny> module can be inflated into the equivalent L<DateTime>
as needing, loading L<DateTime> on the fly if necesary.
-This is somewhat similar to DateTime::LazyInit, but unlike that module
-B<DateTime::Tiny> is not modifiable.
+This is somewhat similar to L<DateTime::LazyInit>, but unlike that module
+B<DateTime::Tiny> objects are not modifiable.
For the purposes of date/time logic, all B<DateTime::Tiny> objects exist
in the "C" locale, and the "floating" time zone. This may be improved in
the future if a suitably tiny way of handling timezones is found.
-When converting up to full L<DateTime> objects, these local and time
+When converting up to full L<DateTime> objects, these locale and time
zone settings will be applied (although an ability is provided to
override this).
@@ -263,7 +263,7 @@ sub second {
=head2 ymdhms
The C<ymdhms> method returns the most common and accurate stringified date
-format, which returns in the form "2006-04-12".
+format, which returns in the form "2006-04-12T23:59:59".
=cut
@@ -291,7 +291,9 @@ sub ymdhms {
The C<from_string> method creates a new B<DateTime::Tiny> object from a string.
-The string is expected to be an ISO 8601 time, with seperators.
+The string is expected to be an ISO 8601 combined date and time
+(including the 'T' separator), with no time zone designator. No other
+ISO 8601 formats are currently supported.
my $almost_midnight = DateTime::Tiny->from_string( '2006-12-20T23:59:59' );
@@ -324,10 +326,10 @@ sub from_string {
=head2 as_string
The C<as_string> method converts the date to the default string, which
-at present is the same as that returned by the C<ymd> method above.
+at present is the same as that returned by the C<ymdhms> method above.
-This string matches the ISO 8601 standard for the encoding of a date as
-a string.
+This string conforms to the ISO 8601 standard for the encoding of a
+combined date-time as a string, without a time zone designator.
=cut
@@ -341,9 +343,9 @@ sub as_string {
The C<DateTime> method is used to create a L<DateTime> object
that is equivalent to the B<DateTime::Tiny> object, for use in
-comversions and caluculations.
+conversions and calculations.
-As mentioned earlier, the object will be set to the 'C' locate,
+As mentioned earlier, the object will be set to the 'C' locale,
and the 'floating' time zone.
If installed, the L<DateTime> module will be loaded automatically.
--
1.7.9