Permalink
Browse files

Fix documentation typos

  • Loading branch information...
mernst committed Apr 5, 2017
1 parent 6ad1338 commit 26695b33a8f25c45e90e6e1a108731347747594e
Showing with 10 additions and 10 deletions.
  1. +6 −6 src/site/xdoc/faq.xml
  2. +1 −1 src/site/xdoc/key_interval.xml
  3. +1 −1 src/site/xdoc/key_partial.xml
  4. +2 −2 src/site/xdoc/userguide.xml
View
@@ -94,7 +94,7 @@ For earlier versions of Joda-Time the situation is more complex:
</p>
<p>
If your application only uses the major time zones of the US, then you need Joda-Time 1.2 or later.
If your application also uses the major time zones of the Canada, then you need Joda-Time 1.2.1 or later.
If your application also uses the major time zones of Canada, then you need Joda-Time 1.2.1 or later.
If your application uses the minor time zones of the US or Canada, then you need Joda-Time 1.4 or later.
For Bermuda (Atlantic/Bermuda) you need Joda-Time 1.4 or later.
For the Bahamas (America/Nassau) you need Joda-Time 1.5.
@@ -142,7 +142,7 @@ designed to operate well with the JDK5 static import facility.
</p>
<p>
If however you want to calculate the number of days, weeks, months and years between
the two dates, then you need a <a href="apidocs/org/joda/time/Period.html">Period</a>
the two dates, then you need a <a href="apidocs/org/joda/time/Period.html">Period</a>.
By default, this will split the difference between the two datetimes into parts,
such as "1 month, 2 weeks, 4 days and 7 hours".
<source>
@@ -183,7 +183,7 @@ This can result in the first week of a year starting in the previous year and th
</p>
<p>
The key point about ISO-8601 is that it is a framework for dates not an absolute single definition.
The most common form is YYYY-MM-DDTHH:MM:SS.SSSZ, in other words year-month-day letter 'T' hour:minute:second and fractions.
The most common form is YYYY-MM-DDTHH:MM:SS.SSSZ, in other words: year-month-day letter 'T' hour:minute:second fractions letter 'Z'.
</p>
</subsection>
@@ -219,7 +219,7 @@ A secondary time interface is <a href="apidocs/org/joda/time/ReadablePartial.ht
Classes implementing this interface store data in two ways. The 'local' classes, such as <code>LocalDate</code>
and <code>LocalTime</code> store the number of milliseconds from 1970 without a time zone.
All other implementations, such as <code>YearMonthDay</code> and <code>TimeOfDay</code>,
store time as a one int value for each field.
store time as one int value for each field.
</p>
</subsection>
@@ -323,10 +323,10 @@ and it might have additional performance costs.
<subsection name="There are lots of classes, do I need to learn them all?">
<p>
No, you only need to learn a small subset of the classes in the API.
The javadoc clearly indicates which packages contain user classes, and which contain
The Javadoc clearly indicates which packages contain user classes, and which contain
implementation classes.
In addition, there are a large number of package scoped classes, which are hidden
in the javadoc view anyway.
in the Javadoc view anyway.
Most applications will not need to directly import, extend or implement classes in
the implementation packages.
Basically, the API consists of the main package, plus the formatting package.
@@ -28,7 +28,7 @@ There are also methods to obtain the <a href="key_duration.html">duration</a> an
<a href="key_period.html">period</a> of the interval.
</p>
<p>
You cannot compare intervals for order (ie. they do not implement <code>Comparable</code>.
You cannot compare intervals for order (i.e., they do not implement <code>Comparable</code>).
If you want to compare the length of intervals you must obtain the duration of each and compare those.
</p>
@@ -25,7 +25,7 @@ The new implementations are <code>LocalDate</code>, <code>LocalTime</code> and <
<p>
It is not possible to directly interoperate between a partial and an <a href="key_instant.html">instant</a>.
A partial does not fully specify a single point in the datetime continuum, but instead may match
multiple points. For example, a <code>LocalTime</code> occurs one per day on the datetime continuum.
multiple points. For example, a <code>LocalTime</code> occurs once per day on the datetime continuum.
</p>
<p>
A partial can be converted to a full instant by specifying the missing values.
@@ -304,7 +304,7 @@ Although the Chronology is key to the design, it is not key to using the API !!
For most applications, the Chronology can be ignored as it will default to the
ISOChronology. This is suitable for most uses.
You would change it if you need accurate dates before October 15, 1582,
or whenever the Julian calendar ceased in the territory you're interested in).
or whenever the Julian calendar ceased in the territory you're interested in.
You'd also change it if you need a specific calendar like the Coptic calendar illustrated earlier.
</p>
</section>
@@ -540,7 +540,7 @@ The property also provides access to other values associated with the field
such as metadata on the minimum and maximum text size, leap status, related
durations, etc. For a complete reference, see the
<a href="apidocs/org/joda/time/field/AbstractReadableInstantFieldProperty.html">documentation</a>
for the base class <code>AbstractReadableInstantFieldProperty</code>
for the base class <code>AbstractReadableInstantFieldProperty</code>.
</p>
<p>
In practice, one would not actually create the intermediate <code>pDoW</code>

0 comments on commit 26695b3

Please sign in to comment.