Skip to content

Commit

Permalink
README list pydocs
Browse files Browse the repository at this point in the history
  • Loading branch information
kata198 committed May 21, 2017
1 parent b6c0265 commit 0c1f6a7
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,13 @@ If there is a return or an exception raised, it will be returned/raised as norma

If the timeout has exceeded, the "FunctionTimedOut" exception will be raised in the context of the function being called, as well as from the context of "func\_timeout". You should have your function catch the "FunctionTimedOut" exception and exit cleanly if possible. Every 2 seconds until your function is terminated, it will continue to raise FunctionTimedOut. The terminating of the timed-out function happens in the context of the thread and will not block main execution.


Pydoc
-----

Find pydoc at https://pythonhosted.org/func_timeout


Support
-------

Expand Down
6 changes: 6 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,12 @@ If there is a return or an exception raised, it will be returned/raised as norma
If the timeout has exceeded, the "FunctionTimedOut" exception will be raised in the context of the function being called, as well as from the context of "func_timeout". You should have your function catch the "FunctionTimedOut" exception and exit cleanly if possible. Every 2 seconds until your function is terminated, it will continue to raise FunctionTimedOut. The terminating of the timed-out function happens in the context of the thread and will not block main execution.


Pydoc
-----

Find pydoc at https://pythonhosted.org/func_timeout


Support
-------

Expand Down

0 comments on commit 0c1f6a7

Please sign in to comment.