Skip to content

Commit

Permalink
Merge pull request #49 from jpcamara/fix-documentation-for-timeout-me…
Browse files Browse the repository at this point in the history
…thod

Global #timeout was removed 5 years ago
  • Loading branch information
olleolleolle authored Aug 28, 2024
2 parents 6c99460 + 213f4e2 commit 6b445fc
Showing 1 changed file with 1 addition and 5 deletions.
6 changes: 1 addition & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,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.

## Installation

Add this line to your application's Gemfile:
Expand All @@ -27,7 +23,7 @@ Or install it yourself as:

```ruby
require 'timeout'
status = Timeout::timeout(5) {
status = Timeout.timeout(5) {
# Something that should be interrupted if it takes more than 5 seconds...
}
```
Expand Down

0 comments on commit 6b445fc

Please sign in to comment.