You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@commons.apache.org by "elharo (via GitHub)" <gi...@apache.org> on 2023/10/06 11:49:36 UTC

[PR] [IO-814] Don't throw UncheckedIOException [commons-io]

elharo opened a new pull request, #491:
URL: https://github.com/apache/commons-io/pull/491

   Fortunately the API here offered a backwards compatible fix. Since it was already declared to return null for some exceptions, this makes it return null for IOException too. This reverts the behavior breaking change without adding any API changes to anyone's code.
   
   Also some javadoc cleanups while I was in here. 


-- 
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.

To unsubscribe, e-mail: issues-unsubscribe@commons.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [IO-814] Don't throw UncheckedIOException [commons-io]

Posted by "codecov-commenter (via GitHub)" <gi...@apache.org>.
codecov-commenter commented on PR #491:
URL: https://github.com/apache/commons-io/pull/491#issuecomment-1751694275

   ## [Codecov](https://app.codecov.io/gh/apache/commons-io/pull/491?src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) Report
   > Merging [#491](https://app.codecov.io/gh/apache/commons-io/pull/491?src=pr&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) (839f442) into [master](https://app.codecov.io/gh/apache/commons-io/commit/877b9e3f5e553f8ad988b89b8adb6b93fa97a964?el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) (877b9e3) will **increase** coverage by `0.06%`.
   > The diff coverage is `0.00%`.
   
   > :exclamation: Current head 839f442 differs from pull request most recent head afc6678. Consider uploading reports for the commit afc6678 to get more accurate results
   
   ```diff
   @@             Coverage Diff              @@
   ##             master     #491      +/-   ##
   ============================================
   + Coverage     84.97%   85.03%   +0.06%     
   - Complexity     3372     3375       +3     
   ============================================
     Files           227      227              
     Lines          8080     8080              
     Branches        953      953              
   ============================================
   + Hits           6866     6871       +5     
   + Misses          960      957       -3     
   + Partials        254      252       -2     
   ```
   
   
   | [Files](https://app.codecov.io/gh/apache/commons-io/pull/491?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | Coverage Δ | |
   |---|---|---|
   | [...ain/java/org/apache/commons/io/file/PathUtils.java](https://app.codecov.io/gh/apache/commons-io/pull/491?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#diff-c3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2NvbW1vbnMvaW8vZmlsZS9QYXRoVXRpbHMuamF2YQ==) | `72.16% <0.00%> (ø)` | |
   
   ... and [2 files with indirect coverage changes](https://app.codecov.io/gh/apache/commons-io/pull/491/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)
   
   :mega: We’re building smart automated test selection to slash your CI/CD build times. [Learn more](https://about.codecov.io/iterative-testing/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)
   


-- 
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.

To unsubscribe, e-mail: notifications-unsubscribe@commons.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [IO-814] Don't throw UncheckedIOException [commons-io]

Posted by "jglick (via GitHub)" <gi...@apache.org>.
jglick commented on PR #491:
URL: https://github.com/apache/commons-io/pull/491#issuecomment-1915245728

   Would a variant of the test from #478 be useful here as a regression test? Like
   
   ```java
   PathUtils.deleteFile(tempDir.resolve("nonexistent").resolve("file-does-not-exist.bin"), StandardDeleteOption.OVERRIDE_READ_ONLY));
   ```
   
   which if I understand correctly should now return normally?


-- 
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.

To unsubscribe, e-mail: issues-unsubscribe@commons.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [IO-814] Don't throw UncheckedIOException [commons-io]

Posted by "garydgregory (via GitHub)" <gi...@apache.org>.
garydgregory commented on PR #491:
URL: https://github.com/apache/commons-io/pull/491#issuecomment-1750689816

   > Except they aren't sentences. They're sentence fragments, and this case is explicitly called out in the [Oracle style guidelines](https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html#tag): "When writing the comments themselves, in general, start with a phrase and follow it with sentences if they are needed. When writing a phrase, do not capitalize and do not end with a period".
   > 
   > If the project wants to diverge from that, it's worth calling it out explicitly in a project specific style guide.
   
   We do, under a header called "Respect The Original Style" on https://commons.apache.org/patches.html
   
   I suppose it could go into more detail of course ;-)
   
   


-- 
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.

To unsubscribe, e-mail: issues-unsubscribe@commons.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [IO-814] Don't throw UncheckedIOException [commons-io]

Posted by "garydgregory (via GitHub)" <gi...@apache.org>.
garydgregory merged PR #491:
URL: https://github.com/apache/commons-io/pull/491


-- 
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.

To unsubscribe, e-mail: issues-unsubscribe@commons.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [IO-814] Don't throw UncheckedIOException [commons-io]

Posted by "elharo (via GitHub)" <gi...@apache.org>.
elharo commented on PR #491:
URL: https://github.com/apache/commons-io/pull/491#issuecomment-1750679442

   Except they aren't sentences. They're sentence fragments, and this case is explicitly called out in the [Oracle style guidelines](https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html#tag): "When writing the comments themselves, in general, start with a phrase and follow it with sentences if they are needed. When writing a phrase, do not capitalize and do not end with a period".
   
   If the project wants to diverge from that, it's worth calling it out explicitly in a project specific style guide. 
   
   
   
   


-- 
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.

To unsubscribe, e-mail: issues-unsubscribe@commons.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [IO-814] Don't throw UncheckedIOException [commons-io]

Posted by "elharo (via GitHub)" <gi...@apache.org>.
elharo commented on PR #491:
URL: https://github.com/apache/commons-io/pull/491#issuecomment-1751697348

   Reverted Javadoc nits. PTAL


-- 
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.

To unsubscribe, e-mail: issues-unsubscribe@commons.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org