dahjah/func_timeout
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Note set_timeout decorator in README

Browse Source
This commit is contained in:
Tim Savannah 2017-05-19 20:49:42 -04:00
parent f8ec7f492c
commit f7baa18e64
2 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -25,6 +25,16 @@ This is the function wherein you pass the timeout, the function you want to call
@return - The return value that #func# gives
'''
**set\_timeout**
This is a decorator you can use on functions to apply func\_timeout. Takes a single argument -- timeout.
Example:
@set_timeout(2.5)
def myFunction(self, arg1, arg2):
...
**FunctionTimedOut**
Exception raised if the function times out

15
README.rst
View File

@ -36,6 +36,21 @@ This is the function wherein you pass the timeout, the function you want to call
'''
**set_timeout**
This is a decorator you can use on functions to apply func_timeout. Takes a single argument -- timeout.
Example:
@set_timeout(2.5)
def myFunction(self, arg1, arg2):
...
**FunctionTimedOut**
Exception raised if the function times out