You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@hc.apache.org by GitBox <gi...@apache.org> on 2021/02/11 07:13:20 UTC
[GitHub] [httpcomponents-core] arturobernalg opened a new pull request #258: Add / Fix / Complete javadoc
arturobernalg opened a new pull request #258:
URL: https://github.com/apache/httpcomponents-core/pull/258
IMO we need a lot of work here with the javadoc.This is a first approach.
----------------------------------------------------------------
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
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
[GitHub] [httpcomponents-core] arturobernalg commented on pull request #258: Add / Fix / Complete javadoc
Posted by GitBox <gi...@apache.org>.
arturobernalg commented on pull request #258:
URL: https://github.com/apache/httpcomponents-core/pull/258#issuecomment-778417722
Close the PR to make it private
----------------------------------------------------------------
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
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
[GitHub] [httpcomponents-core] arturobernalg closed pull request #258: Add / Fix / Complete javadoc
Posted by GitBox <gi...@apache.org>.
arturobernalg closed pull request #258:
URL: https://github.com/apache/httpcomponents-core/pull/258
----------------------------------------------------------------
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
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
[GitHub] [httpcomponents-core] arturobernalg commented on a change in pull request #258: Add / Fix / Complete javadoc
Posted by GitBox <gi...@apache.org>.
arturobernalg commented on a change in pull request #258:
URL: https://github.com/apache/httpcomponents-core/pull/258#discussion_r575484178
##########
File path: httpcore5-h2/src/main/java/org/apache/hc/core5/http2/nio/AsyncPingHandler.java
##########
@@ -49,6 +49,8 @@
* Triggered to signal receipt of a ping response message.
*
* @param feedback the ping message feedback.
+ * @throws IOException in case of an I/O error
Review comment:
:) you're right. I apologize.
----------------------------------------------------------------
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
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
[GitHub] [httpcomponents-core] ok2c commented on a change in pull request #258: Add / Fix / Complete javadoc
Posted by GitBox <gi...@apache.org>.
ok2c commented on a change in pull request #258:
URL: https://github.com/apache/httpcomponents-core/pull/258#discussion_r575428259
##########
File path: httpcore5-h2/src/main/java/org/apache/hc/core5/http2/nio/AsyncPingHandler.java
##########
@@ -49,6 +49,8 @@
* Triggered to signal receipt of a ping response message.
*
* @param feedback the ping message feedback.
+ * @throws IOException in case of an I/O error
Review comment:
@arturobernalg Are these all javadoc fixes you have in mind or are you planning on adding more at some point? Preferably I would like to avoid multiple `Add / Fix / Complete javadoc` commits.
----------------------------------------------------------------
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
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
[GitHub] [httpcomponents-core] ok2c commented on a change in pull request #258: Add / Fix / Complete javadoc
Posted by GitBox <gi...@apache.org>.
ok2c commented on a change in pull request #258:
URL: https://github.com/apache/httpcomponents-core/pull/258#discussion_r575090675
##########
File path: httpcore5-h2/src/main/java/org/apache/hc/core5/http2/nio/AsyncPingHandler.java
##########
@@ -49,6 +49,8 @@
* Triggered to signal receipt of a ping response message.
*
* @param feedback the ping message feedback.
+ * @throws IOException in case of an I/O error
Review comment:
@arturobernalg I honestly think this is just not worth it. `@throws IOException in case of an I/O error` adds no value to the javadocs. I am not sure what I am to do about this PR.
----------------------------------------------------------------
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
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
[GitHub] [httpcomponents-core] ok2c commented on a change in pull request #258: Add / Fix / Complete javadoc
Posted by GitBox <gi...@apache.org>.
ok2c commented on a change in pull request #258:
URL: https://github.com/apache/httpcomponents-core/pull/258#discussion_r575481651
##########
File path: httpcore5-h2/src/main/java/org/apache/hc/core5/http2/nio/AsyncPingHandler.java
##########
@@ -49,6 +49,8 @@
* Triggered to signal receipt of a ping response message.
*
* @param feedback the ping message feedback.
+ * @throws IOException in case of an I/O error
Review comment:
@arturobernalg To make my life a bit easier could you please keep those changes on a private batch and merge that branch with a single PR once ready?
----------------------------------------------------------------
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
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
[GitHub] [httpcomponents-core] arturobernalg commented on a change in pull request #258: Add / Fix / Complete javadoc
Posted by GitBox <gi...@apache.org>.
arturobernalg commented on a change in pull request #258:
URL: https://github.com/apache/httpcomponents-core/pull/258#discussion_r575466417
##########
File path: httpcore5-h2/src/main/java/org/apache/hc/core5/http2/nio/AsyncPingHandler.java
##########
@@ -49,6 +49,8 @@
* Triggered to signal receipt of a ping response message.
*
* @param feedback the ping message feedback.
+ * @throws IOException in case of an I/O error
Review comment:
Hi @ok2c
my idea it's progressively add the missing javadoc. I am not sure whether to do it in several PRs or in just one
----------------------------------------------------------------
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
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
[GitHub] [httpcomponents-core] arturobernalg commented on a change in pull request #258: Add / Fix / Complete javadoc
Posted by GitBox <gi...@apache.org>.
arturobernalg commented on a change in pull request #258:
URL: https://github.com/apache/httpcomponents-core/pull/258#discussion_r575410273
##########
File path: httpcore5-h2/src/main/java/org/apache/hc/core5/http2/nio/AsyncPingHandler.java
##########
@@ -49,6 +49,8 @@
* Triggered to signal receipt of a ping response message.
*
* @param feedback the ping message feedback.
+ * @throws IOException in case of an I/O error
Review comment:
hi @ok2c maybe you're right. Any advice to how proceed now? I'm honestly miss the javadoc in the above class and don't think it's important give all information that we can to the user's.
----------------------------------------------------------------
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
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
[GitHub] [httpcomponents-core] arturobernalg commented on a change in pull request #258: Add / Fix / Complete javadoc
Posted by GitBox <gi...@apache.org>.
arturobernalg commented on a change in pull request #258:
URL: https://github.com/apache/httpcomponents-core/pull/258#discussion_r575466417
##########
File path: httpcore5-h2/src/main/java/org/apache/hc/core5/http2/nio/AsyncPingHandler.java
##########
@@ -49,6 +49,8 @@
* Triggered to signal receipt of a ping response message.
*
* @param feedback the ping message feedback.
+ * @throws IOException in case of an I/O error
Review comment:
Hi @ok2c
my idea it's progressively add the missing javadoc. I am not sure whether to do it in several PRs or in just one.
An example. http://hc.apache.org/httpcomponents-core-5.0.x/httpcore5/apidocs/org/apache/hc/core5/concurrent/DefaultThreadFactory.html
I really miss a good and robust documentation.
----------------------------------------------------------------
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
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org