Skip to content

Commit

Permalink
Fix WriteTimeoutException java doc description (netty#9554)
Browse files Browse the repository at this point in the history
Motivation:

The java doc doesn't match the real case: The exception only happen when a write operation
 cannot finish in a certain period of time instead of write idle happen.

Modification:

Correct java doc

Result:
java doc matched the real case
  • Loading branch information
jiafu1115 authored and normanmaurer committed Sep 9, 2019
1 parent 629eae2 commit 454cc80
Showing 1 changed file with 2 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@
import io.netty.util.internal.PlatformDependent;

/**
* A {@link TimeoutException} raised by {@link WriteTimeoutHandler} when no data
* was written within a certain period of time.
* A {@link TimeoutException} raised by {@link WriteTimeoutHandler} when a write operation
* cannot finish in a certain period of time.
*/
public final class WriteTimeoutException extends TimeoutException {

Expand Down

0 comments on commit 454cc80

Please sign in to comment.