[GitHub] [commons-io] garydgregory commented on pull request #291: Improve `ReaderInputStream` documentation
garydgregory commented on pull request #291: URL: https://github.com/apache/commons-io/pull/291#issuecomment-966576842 You have 2 PRs with same title, this is confusing and wasted reviewers' time. Please pick one and close the other. -- 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-unsubscr...@commons.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
[GitHub] [commons-io] garydgregory commented on pull request #291: Improve `ReaderInputStream` documentation
garydgregory commented on pull request #291: URL: https://github.com/apache/commons-io/pull/291#issuecomment-956311701 In general, if you are _fixing_ something in a PR, don't mix that with style changes. -- 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-unsubscr...@commons.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
[GitHub] [commons-io] garydgregory commented on pull request #291: Improve `ReaderInputStream` documentation
garydgregory commented on pull request #291: URL: https://github.com/apache/commons-io/pull/291#issuecomment-956311054 > See also https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html#inlinelinks (in case you have not noticed it in the commit message); though it might be slightly dated. Obviously dated indeed since this document talks about old style HTML links which were underlined, and which Javadoc no longer generates. You'll notice on our Javadoc pages, the hyperlink coloring is rather (IMO) subtle and no longer the harsh bright blue with underline style from the Web 1.0 days. -- 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-unsubscr...@commons.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
[GitHub] [commons-io] garydgregory commented on pull request #291: Improve `ReaderInputStream` documentation
garydgregory commented on pull request #291:
URL: https://github.com/apache/commons-io/pull/291#issuecomment-956307294
> Not even when referring to the class itself (`{@link ReaderInputStream
}`)? To me it appears that this does not add any value; when you are already
reading the documentation of `ReaderInputStream` you don't want to open its
documentation again.
To me, the value is that you get a shortcut to the class comment.
--
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-unsubscr...@commons.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
[GitHub] [commons-io] garydgregory commented on pull request #291: Improve `ReaderInputStream` documentation
garydgregory commented on pull request #291: URL: https://github.com/apache/commons-io/pull/291#issuecomment-955762052 @Marcono1234 Do not change `@link` to `@code`. -- 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-unsubscr...@commons.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
