RFR: 8326687: Inconsistent use of "ZIP", "Zip" and "zip" in java.util.zip/jar zipfs javadoc [v2]
Jaikiran Pai
jpai at openjdk.org
Wed Feb 28 14:00:53 UTC 2024
On Tue, 27 Feb 2024 16:15:06 GMT, Lance Andersen <lancea at openjdk.org> wrote:
>> This PR updates the javadoc and comments within java.util.zip/jar and zipfs module summary so that it is consistent with the use of "ZIP".
>>
>> In addition, open/src/java.base/share/classes/java/util/zip/package-info.java has been updated to point to the higher level location of the PKWARE APPNOTE.TXT has PKWare recently changed the direct path the the latest version of the spec.
>>
>> It is also worth noting that error messages were not updated as part of the PR and will be updated separately to keep the javadoc changes separate
>
> Lance Andersen has updated the pull request incrementally with one additional commit since the last revision:
>
> Address initial feedback for JDK-8326687
Hello Lance, this doc-only change looks good to me.
These changes are merely changing the case of `zip` and aren't changing any specification of the APIs and that looks fine to me.
I had imagined that we would be changing only the public API documentations but I suspect you decided to update even code comments and internal class comments to keep everything consistent. I am not opposing it and I ask this so that I can use this decision in future when adding anything in this area or reviewing code.
-------------
Marked as reviewed by jpai (Reviewer).
PR Review: https://git.openjdk.org/jdk/pull/18011#pullrequestreview-1906340184
More information about the core-libs-dev
mailing list