summaryrefslogtreecommitdiff
path: root/lib/net
diff options
context:
space:
mode:
authornaruse <naruse@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2018-06-08 17:20:20 +0000
committernaruse <naruse@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2018-06-08 17:20:20 +0000
commit51cfea31e559ce281f7252a2dd0117f61a44912e (patch)
tree6f381476d9164d45ed4a008a98d017337ddb11f4 /lib/net
parentb5b7820ec28e2ce950c17dbdaae33412254d8fc2 (diff)
write_timeout doc upates [skip ci]
From: MSP-Greg <MSP-Greg@users.noreply.github.com> fix https://github.com/ruby/ruby/pull/1885 git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@63615 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/net')
-rw-r--r--lib/net/http.rb3
-rw-r--r--lib/net/protocol.rb2
2 files changed, 3 insertions, 2 deletions
diff --git a/lib/net/http.rb b/lib/net/http.rb
index bfd0001422..281b15cedf 100644
--- a/lib/net/http.rb
+++ b/lib/net/http.rb
@@ -742,10 +742,11 @@ module Net #:nodoc:
# it raises a Net::ReadTimeout exception. The default value is 60 seconds.
attr_reader :read_timeout
- # Number of seconds to wait for one block to be write (via one write(2)
+ # Number of seconds to wait for one block to be written (via one write(2)
# call). Any number may be used, including Floats for fractional
# seconds. If the HTTP object cannot write data in this many seconds,
# it raises a Net::WriteTimeout exception. The default value is 60 seconds.
+ # Net::WriteTimeout is not raised on Windows.
attr_reader :write_timeout
# Maximum number of times to retry an idempotent request in case of
diff --git a/lib/net/protocol.rb b/lib/net/protocol.rb
index 1fcf59519b..037fcd8358 100644
--- a/lib/net/protocol.rb
+++ b/lib/net/protocol.rb
@@ -79,7 +79,7 @@ module Net # :nodoc:
##
# WriteTimeout, a subclass of Timeout::Error, is raised if a chunk of the
- # response cannot be write within the write_timeout.
+ # response cannot be written within the write_timeout. Not raised on Windows.
class WriteTimeout < Timeout::Error; end