timeout.rb: Update documentation

olleolleolle · olleolleolle · commit 683fdb45ee4a · 2024-08-28T12:58:20.000+02:00
This is a followup to #49.
diff --git a/lib/timeout.rb b/lib/timeout.rb
@@ -4,7 +4,7 @@
 # == Synopsis
 #
 #   require 'timeout'
-#   status = Timeout::timeout(5) {
+#   status = Timeout.timeout(5) {
 #     # Something that should be interrupted if it takes more than 5 seconds...
 #   }
 #
@@ -13,10 +13,6 @@
 # Timeout provides a way to auto-terminate a potentially long-running
 # operation if it hasn't finished in a fixed amount of time.
 #
-# Previous versions didn't use a module for namespacing, however
-# #timeout is provided for backwards compatibility.  You
-# should prefer Timeout.timeout instead.
-#
 # == Copyright
 #
 # Copyright:: (C) 2000  Network Applied Communication Laboratory, Inc.

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`# == Synopsis`
`5`	`5`	`#`
`6`	`6`	`# require 'timeout'`
`7`		`-# status = Timeout::timeout(5) {`
	`7`	`+# status = Timeout.timeout(5) {`
`8`	`8`	`# # Something that should be interrupted if it takes more than 5 seconds...`
`9`	`9`	`# }`
`10`	`10`	`#`
`@@ -13,10 +13,6 @@`
`13`	`13`	`# Timeout provides a way to auto-terminate a potentially long-running`
`14`	`14`	`# operation if it hasn't finished in a fixed amount of time.`
`15`	`15`	`#`
`16`		`-# Previous versions didn't use a module for namespacing, however`
`17`		`-# #timeout is provided for backwards compatibility. You`
`18`		`-# should prefer Timeout.timeout instead.`
`19`		`-#`
`20`	`16`	`# == Copyright`
`21`	`17`	`#`
`22`	`18`	`# Copyright:: (C) 2000 Network Applied Communication Laboratory, Inc.`