You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@commons.apache.org by "ASF GitHub Bot (Jira)" <ji...@apache.org> on 2020/06/02 15:26:00 UTC
[jira] [Work logged] (COMPRESS-533) Refine javadoc and fix typos
[ https://issues.apache.org/jira/browse/COMPRESS-533?focusedWorklogId=440193&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-440193 ]
ASF GitHub Bot logged work on COMPRESS-533:
-------------------------------------------
Author: ASF GitHub Bot
Created on: 02/Jun/20 15:25
Start Date: 02/Jun/20 15:25
Worklog Time Spent: 10m
Work Description: bodewig commented on a change in pull request #104:
URL: https://github.com/apache/commons-compress/pull/104#discussion_r433958060
##########
File path: src/main/java/org/apache/commons/compress/compressors/lzma/LZMAUtils.java
##########
@@ -146,7 +146,7 @@ public static String getCompressedFilename(final String fileName) {
* <p>This defaults to {@code false} in an OSGi environment and {@code true} otherwise.</p>
* @param doCache whether to cache the result
*/
- public static void setCacheLZMAAvailablity(final boolean doCache) {
Review comment:
Even if its spelling is wrong, we cannot change the name of a public method as it would break backwards compatibility.
##########
File path: src/main/java/org/apache/commons/compress/compressors/xz/XZUtils.java
##########
@@ -163,7 +163,7 @@ public static String getCompressedFilename(final String fileName) {
* @param doCache whether to cache the result
* @since 1.9
*/
- public static void setCacheXZAvailablity(final boolean doCache) {
+ public static void setCacheXZAvailability(final boolean doCache) {
Review comment:
same as above, this would break backwards compatibility.
##########
File path: src/main/java/org/apache/commons/compress/compressors/zstandard/ZstdUtils.java
##########
@@ -85,7 +85,7 @@ private static boolean internalIsZstdCompressionAvailable() {
* <p>This defaults to {@code false} in an OSGi environment and {@code true} otherwise.</p>
* @param doCache whether to cache the result
*/
- public static void setCacheZstdAvailablity(final boolean doCache) {
+ public static void setCacheZstdAvailability(final boolean doCache) {
Review comment:
and again, we will have to live with a misspelled method name.
##########
File path: src/main/java/org/apache/commons/compress/compressors/brotli/BrotliUtils.java
##########
@@ -72,7 +72,7 @@ private static boolean internalIsBrotliCompressionAvailable() {
* <p>This defaults to {@code false} in an OSGi environment and {@code true} otherwise.</p>
* @param doCache whether to cache the result
*/
- public static void setCacheBrotliAvailablity(final boolean doCache) {
+ public static void setCacheBrotliAvailability(final boolean doCache) {
Review comment:
this change breaks backwards compatibility,
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Issue Time Tracking
-------------------
Worklog Id: (was: 440193)
Remaining Estimate: 0h
Time Spent: 10m
> Refine javadoc and fix typos
> ----------------------------
>
> Key: COMPRESS-533
> URL: https://issues.apache.org/jira/browse/COMPRESS-533
> Project: Commons Compress
> Issue Type: Improvement
> Reporter: JIN XU
> Priority: Minor
> Time Spent: 10m
> Remaining Estimate: 0h
>
> [https://github.com/apache/commons-compress/pull/104]
--
This message was sent by Atlassian Jira
(v8.3.4#803005)