You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@commons.apache.org by GitBox <gi...@apache.org> on 2020/06/02 13:43:51 UTC
[GitHub] [commons-compress] XenoAmess opened a new pull request #104: Refine javadoc and fix typos
XenoAmess opened a new pull request #104:
URL: https://github.com/apache/commons-compress/pull/104
Refine javadoc and fix typos
----------------------------------------------------------------
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
[GitHub] [commons-compress] bodewig commented on a change in pull request #104: [COMPRESS-533] Refine javadoc and fix typos
Posted by GitBox <gi...@apache.org>.
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
[GitHub] [commons-compress] bodewig merged pull request #104: [COMPRESS-533] Refine javadoc and fix typos
Posted by GitBox <gi...@apache.org>.
bodewig merged pull request #104:
URL: https://github.com/apache/commons-compress/pull/104
----------------------------------------------------------------
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
[GitHub] [commons-compress] XenoAmess commented on a change in pull request #104: [COMPRESS-533] Refine javadoc and fix typos
Posted by GitBox <gi...@apache.org>.
XenoAmess commented on a change in pull request #104:
URL: https://github.com/apache/commons-compress/pull/104#discussion_r434015443
##########
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.
done.
----------------------------------------------------------------
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
[GitHub] [commons-compress] XenoAmess commented on a change in pull request #104: [COMPRESS-533] Refine javadoc and fix typos
Posted by GitBox <gi...@apache.org>.
XenoAmess commented on a change in pull request #104:
URL: https://github.com/apache/commons-compress/pull/104#discussion_r434014704
##########
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.
done.
----------------------------------------------------------------
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
[GitHub] [commons-compress] XenoAmess commented on a change in pull request #104: [COMPRESS-533] Refine javadoc and fix typos
Posted by GitBox <gi...@apache.org>.
XenoAmess commented on a change in pull request #104:
URL: https://github.com/apache/commons-compress/pull/104#discussion_r434015189
##########
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,
done.
----------------------------------------------------------------
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
[GitHub] [commons-compress] coveralls edited a comment on pull request #104: [COMPRESS-533] Refine javadoc and fix typos
Posted by GitBox <gi...@apache.org>.
coveralls edited a comment on pull request #104:
URL: https://github.com/apache/commons-compress/pull/104#issuecomment-637555662
[](https://coveralls.io/builds/31190148)
Coverage increased (+0.01%) to 87.242% when pulling **e2a1a418c2e8ff881d46d6827ba79436b047b786 on XenoAmess:refine_javadoc_and_fix_typos** into **637469893b0ade91d8bca61c25e0e9282f977213 on apache:master**.
----------------------------------------------------------------
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
[GitHub] [commons-compress] XenoAmess commented on a change in pull request #104: [COMPRESS-533] Refine javadoc and fix typos
Posted by GitBox <gi...@apache.org>.
XenoAmess commented on a change in pull request #104:
URL: https://github.com/apache/commons-compress/pull/104#discussion_r434014481
##########
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.
done.
----------------------------------------------------------------
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
[GitHub] [commons-compress] coveralls commented on pull request #104: Refine javadoc and fix typos
Posted by GitBox <gi...@apache.org>.
coveralls commented on pull request #104:
URL: https://github.com/apache/commons-compress/pull/104#issuecomment-637555662
[](https://coveralls.io/builds/31186025)
Coverage increased (+0.01%) to 87.242% when pulling **1ac816fde7ae874f9903fea0cefeef43557abffd on XenoAmess:refine_javadoc_and_fix_typos** into **637469893b0ade91d8bca61c25e0e9282f977213 on apache:master**.
----------------------------------------------------------------
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
[GitHub] [commons-compress] XenoAmess commented on pull request #104: [COMPRESS-533] Refine javadoc and fix typos
Posted by GitBox <gi...@apache.org>.
XenoAmess commented on pull request #104:
URL: https://github.com/apache/commons-compress/pull/104#issuecomment-637665602
@bodewig
done.
I also have a question.
Do `archiveName` and `archiverName` means one same thing in this repo?
If so, should we consider uniform them to `archiveName` or `archiverName`?
Asked because I found both several `archiveName` and several `archiverName`, and I got kindof confused.
----------------------------------------------------------------
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
[GitHub] [commons-compress] XenoAmess commented on pull request #104: [COMPRESS-533] Refine javadoc and fix typos
Posted by GitBox <gi...@apache.org>.
XenoAmess commented on pull request #104:
URL: https://github.com/apache/commons-compress/pull/104#issuecomment-638002153
> I'm not sure we've got an agreed upon language at all :-)
> In this particular case it may depend on the context. `archiveName` would be the file name of an archive, `archiverName` represent the archive format tar/zip/7z...
Ok, I get it now, thx.
----------------------------------------------------------------
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
[GitHub] [commons-compress] bodewig commented on pull request #104: [COMPRESS-533] Refine javadoc and fix typos
Posted by GitBox <gi...@apache.org>.
bodewig commented on pull request #104:
URL: https://github.com/apache/commons-compress/pull/104#issuecomment-637943848
I'm not sure we've got an agreed upon language at all :-)
In this particular case it may depend on the context. `archiveName` would be the file name of an archive, `archiverName` represent the archive format tar/zip/7z...
----------------------------------------------------------------
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