README list pydocs

This commit is contained in:
Tim Savannah 2017-05-20 21:40:34 -04:00
parent b6c02653b8
commit 0c1f6a7de6
2 changed files with 13 additions and 0 deletions

View File

@ -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. 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 Support
------- -------

View File

@ -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. 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 Support
------- -------