RFR JDK-8171348: Incorrect documentation for DateTimeFormatter letter 'k'
Abhijit Roy
abhijit.r.roy at oracle.com
Mon Dec 26 18:40:47 UTC 2016
Hi Roger,
Could you please push it for 9ea? If so, please find the attached
changeset files.
Regards
Abhijit
On 12/21/2016 7:53 PM, Roger Riggs wrote:
> Hi Abhijit,
>
> Looks fine to push with this additional change to make the
> descriptions of 'F' match.
>
> Thanks, Roger
>
>
> On 12/21/16 7:16 AM, Ivan Gerasimov wrote:
>> Hi Abhijt!
>>
>> As you're changing the description of 'F' pattern in
>> DateTimeFormatterBuilder, it makes sense to do the same in
>> DateTimeFormatter.
>>
>> With kind regards,
>> Ivan
>>
>>
>> On 21.12.2016 9:30, Abhijit Roy wrote:
>>> Hi Roger,
>>>
>>> I have fixed the same error in DateTimeFormatterBuiler. Please see
>>> the updated webrev below.
>>>
>>> Webrev: http://cr.openjdk.java.net/~rpatil/8171348/webrev.01/
>>>
>>> Thanks
>>> Abhijit
>>>
>>>
>>> On 12/16/2016 8:01 PM, Roger Riggs wrote:
>>>> Hi,
>>>>
>>>> Sorry, I meant DateTimeFormatterBuilder.
>>>>
>>>> Roger
>>>>
>>>>
>>>> On 12/16/2016 9:28 AM, Roger Riggs wrote:
>>>>> Hi Abhijit,
>>>>>
>>>>> Please also fix the same error in DateTimeFormatter; line 300.
>>>>>
>>>>> I would use '24' as the example of the hour of day.
>>>>> It would emphasize that the range is 1-24.
>>>>>
>>>>> Roger
>>>>>
>>>>>
>>>>> On 12/16/2016 6:19 AM, Abhijit Roy wrote:
>>>>>> Hi all,
>>>>>>
>>>>>>
>>>>>> Please review the java doc fix for the below bug:
>>>>>>
>>>>>> Bug: https://bugs.openjdk.java.net/browse/JDK-8171348
>>>>>>
>>>>>> Description: Incorrect documentation for DateTimeFormatter letter
>>>>>> 'k'
>>>>>>
>>>>>> Webrev: http://cr.openjdk.java.net/~rpatil/8171348/webrev.00/
>>>>>>
>>>>>>
>>>>>> I have just rectified and modified those errors. And moving
>>>>>> forward it for review.
>>>>>>
>>>>>>
>>>>>> Regards,
>>>>>>
>>>>>> Abhijit
>>>>>>
>>>>>>
>>>>>>
>>>>>> P.S. It will be merged with RFR: JDK-8164923, JDK-8170566,
>>>>>> JDK-8169482, JDK-8170653
>>>>>
>>>>
>>>
>>>
>>
>
-------------- next part --------------
# HG changeset patch
# User Abhijit Roy
# Date 1482429952 -19800
# Thu Dec 22 23:35:52 2016 +0530
# Node ID d25f6a50496155bc519104863e8adbe6a25af330
# Parent c709e74ffcf65e82043ecd2370217e0df2805257
8164923: Error in the documentation for java.lang.Random
Reviewed-by: rriggs
Contributed-by: abhijit.r.roy at oracle.com
diff -r c709e74ffcf6 -r d25f6a504961 src/java.base/share/classes/java/util/Random.java
--- a/src/java.base/share/classes/java/util/Random.java Tue Sep 20 08:46:33 2016 +0200
+++ b/src/java.base/share/classes/java/util/Random.java Thu Dec 22 23:35:52 2016 +0530
@@ -187,7 +187,7 @@
*
* This is a linear congruential pseudorandom number generator, as
* defined by D. H. Lehmer and described by Donald E. Knuth in
- * <i>The Art of Computer Programming,</i> Volume 3:
+ * <i>The Art of Computer Programming,</i> Volume 2:
* <i>Seminumerical Algorithms</i>, section 3.2.1.
*
* @param bits random bits
@@ -570,7 +570,7 @@
* }}</pre>
* This uses the <i>polar method</i> of G. E. P. Box, M. E. Muller, and
* G. Marsaglia, as described by Donald E. Knuth in <i>The Art of
- * Computer Programming</i>, Volume 3: <i>Seminumerical Algorithms</i>,
+ * Computer Programming</i>, Volume 2: <i>Seminumerical Algorithms</i>,
* section 3.4.1, subsection C, algorithm P. Note that it generates two
* independent values at the cost of only one call to {@code StrictMath.log}
* and one call to {@code StrictMath.sqrt}.
-------------- next part --------------
# HG changeset patch
# User Abhijit Roy
# Date 1482773246 -19800
# Mon Dec 26 22:57:26 2016 +0530
# Node ID 47a681cd74eec8c0b913e13a0dc85933d2d9ee95
# Parent ce85bfbe98b0471b4aa8ce504d078e8c1a5b4e0e
8169482: java.time.DateTimeFormatter javadoc: F is not week-of-month
Reviewed-by: rriggs
Contributed-by: abhijit.r.roy at oracle.com
diff -r ce85bfbe98b0 -r 47a681cd74ee src/java.base/share/classes/java/time/format/DateTimeFormatter.java
--- a/src/java.base/share/classes/java/time/format/DateTimeFormatter.java Sun Dec 25 19:29:06 2016 +0100
+++ b/src/java.base/share/classes/java/time/format/DateTimeFormatter.java Mon Dec 26 22:57:26 2016 +0530
@@ -292,7 +292,7 @@
* W week-of-month number 4
* E day-of-week text Tue; Tuesday; T
* e/c localized day-of-week number/text 2; 02; Tue; Tuesday; T
- * F week-of-month number 3
+ * F day-of-week-in-month number 3
*
* a am-pm-of-day text PM
* h clock-hour-of-am-pm (1-12) number 12
-------------- next part --------------
# HG changeset patch
# User Abhijit Roy
# Date 1482773994 -19800
# Mon Dec 26 23:09:54 2016 +0530
# Node ID 45de439dcca920dad3ccfa4366f843a0285eb606
# Parent ce85bfbe98b0471b4aa8ce504d078e8c1a5b4e0e
8170566: Incorrect phrase usage in javadocs documentation
Reviewed-by: rriggs
Contributed-by: abhijit.r.roy at oracle.com
diff -r ce85bfbe98b0 -r 45de439dcca9 src/java.base/share/classes/java/util/function/package-info.java
--- a/src/java.base/share/classes/java/util/function/package-info.java Sun Dec 25 19:29:06 2016 +0100
+++ b/src/java.base/share/classes/java/util/function/package-info.java Mon Dec 26 23:09:54 2016 +0530
@@ -74,7 +74,7 @@
* {@link java.util.function.Function} (unary function from {@code T} to {@code R}),
* {@link java.util.function.Consumer} (unary function from {@code T} to {@code void}),
* {@link java.util.function.Predicate} (unary function from {@code T} to {@code boolean}),
- * and {@link java.util.function.Supplier} (nilary function to {@code R}).
+ * and {@link java.util.function.Supplier} (nullary function to {@code R}).
* </li>
*
* <li>Function shapes have a natural arity based on how they are most
-------------- next part --------------
# HG changeset patch
# User Abhijit Roy
# Date 1482774306 -19800
# Mon Dec 26 23:15:06 2016 +0530
# Node ID 225b6ff18cda2c2a88a45784b4d0462246c1b1cc
# Parent ce85bfbe98b0471b4aa8ce504d078e8c1a5b4e0e
8170653: The javadoc of ZoneRules.previousTransition() is wrong
Reviewed-by: rriggs
Contributed-by: abhijit.r.roy at oracle.com
diff -r ce85bfbe98b0 -r 225b6ff18cda src/java.base/share/classes/java/time/zone/ZoneRules.java
--- a/src/java.base/share/classes/java/time/zone/ZoneRules.java Sun Dec 25 19:29:06 2016 +0100
+++ b/src/java.base/share/classes/java/time/zone/ZoneRules.java Mon Dec 26 23:15:06 2016 +0530
@@ -871,13 +871,13 @@
/**
* Gets the previous transition before the specified instant.
* <p>
- * This returns details of the previous transition after the specified instant.
+ * This returns details of the previous transition before the specified instant.
* For example, if the instant represents a point where "summer" daylight saving time
* applies, then the method will return the transition from the previous "winter" time.
*
* @param instant the instant to get the previous transition after, not null, but null
* may be ignored if the rules have a single offset for all instants
- * @return the previous transition after the specified instant, null if this is before the first transition
+ * @return the previous transition before the specified instant, null if this is before the first transition
*/
public ZoneOffsetTransition previousTransition(Instant instant) {
if (savingsInstantTransitions.length == 0) {
-------------- next part --------------
# HG changeset patch
# User Abhijit Roy
# Date 1482774657 -19800
# Mon Dec 26 23:20:57 2016 +0530
# Node ID 94c26e762952f03c08f9d05c8c5ba1a897fcccf1
# Parent ce85bfbe98b0471b4aa8ce504d078e8c1a5b4e0e
8171348: Incorrect documentation for DateTimeFormatter letter 'k'
Reviewed-by: rriggs
Contributed-by: abhijit.r.roy at oracle.com
diff -r ce85bfbe98b0 -r 94c26e762952 src/java.base/share/classes/java/time/format/DateTimeFormatter.java
--- a/src/java.base/share/classes/java/time/format/DateTimeFormatter.java Sun Dec 25 19:29:06 2016 +0100
+++ b/src/java.base/share/classes/java/time/format/DateTimeFormatter.java Mon Dec 26 23:20:57 2016 +0530
@@ -297,7 +297,7 @@
* a am-pm-of-day text PM
* h clock-hour-of-am-pm (1-12) number 12
* K hour-of-am-pm (0-11) number 0
- * k clock-hour-of-am-pm (1-24) number 0
+ * k clock-hour-of-day (1-24) number 24
*
* H hour-of-day (0-23) number 0
* m minute-of-hour number 30
diff -r ce85bfbe98b0 -r 94c26e762952 src/java.base/share/classes/java/time/format/DateTimeFormatterBuilder.java
--- a/src/java.base/share/classes/java/time/format/DateTimeFormatterBuilder.java Sun Dec 25 19:29:06 2016 +0100
+++ b/src/java.base/share/classes/java/time/format/DateTimeFormatterBuilder.java Mon Dec 26 23:20:57 2016 +0530
@@ -1486,12 +1486,12 @@
* W week-of-month number 4
* E day-of-week text Tue; Tuesday; T
* e/c localized day-of-week number/text 2; 02; Tue; Tuesday; T
- * F week-of-month number 3
+ * F day-of-week-in-month number 3
*
* a am-pm-of-day text PM
* h clock-hour-of-am-pm (1-12) number 12
* K hour-of-am-pm (0-11) number 0
- * k clock-hour-of-am-pm (1-24) number 0
+ * k clock-hour-of-day (1-24) number 24
*
* H hour-of-day (0-23) number 0
* m minute-of-hour number 30
More information about the core-libs-dev
mailing list