Added a note to the documentation of Socket.tcp

shioimm · shioimm · commit 7126eb6ff1ec · 2025-07-16T21:01:55.000+09:00
diff --git a/ext/socket/lib/socket.rb b/ext/socket/lib/socket.rb
@@ -643,7 +643,7 @@ def accept_nonblock(exception: true)
   #
   # [:resolv_timeout] Specifies the timeout in seconds from when the hostname resolution starts.
   # [:connect_timeout] This method sequentially attempts connecting to all candidate destination addresses.<br>The +connect_timeout+ specifies the timeout in seconds from the start of the connection attempt to the last candidate.<br>By default, all connection attempts continue until the timeout occurs.<br>When +fast_fallback:false+ is explicitly specified,<br>a timeout is set for each connection attempt and any connection attempt that exceeds its timeout will be canceled.
-  # [:open_timeout] Specifies the timeout in seconds from the start of the method execution.<br>If this timeout is reached while there are still addresses that have not yet been attempted for connection, no further attempts will be made.
+  # [:Specifies the timeout in seconds from the start of the method execution.<br>If this timeout is reached while there are still addresses that have not yet been attempted for connection, no further attempts will be made.<br>If this option is specified together with other timeout options, an +ArgumentError+ will be raised.
   # [:fast_fallback] Enables the Happy Eyeballs Version 2 algorithm (enabled by default).
   #
   # If a block is given, the block is called with the socket.

Original file line number	Diff line number	Diff line change
`@@ -643,7 +643,7 @@ def accept_nonblock(exception: true)`
`643`	`643`	`#`
`644`	`644`	`# [:resolv_timeout] Specifies the timeout in seconds from when the hostname resolution starts.`
`645`	`645`	`# [:connect_timeout] This method sequentially attempts connecting to all candidate destination addresses.<br>The +connect_timeout+ specifies the timeout in seconds from the start of the connection attempt to the last candidate.<br>By default, all connection attempts continue until the timeout occurs.<br>When +fast_fallback:false+ is explicitly specified,<br>a timeout is set for each connection attempt and any connection attempt that exceeds its timeout will be canceled.`
`646`		`- # [:open_timeout] Specifies the timeout in seconds from the start of the method execution.<br>If this timeout is reached while there are still addresses that have not yet been attempted for connection, no further attempts will be made.`
	`646`	`+ # [:Specifies the timeout in seconds from the start of the method execution.<br>If this timeout is reached while there are still addresses that have not yet been attempted for connection, no further attempts will be made.<br>If this option is specified together with other timeout options, an +ArgumentError+ will be raised.`
`647`	`647`	`# [:fast_fallback] Enables the Happy Eyeballs Version 2 algorithm (enabled by default).`
`648`	`648`	`#`
`649`	`649`	`# If a block is given, the block is called with the socket.`