From 525c291aef62e2c442138f4f722ee9fbe82a1455 Mon Sep 17 00:00:00 2001 From: Tim Savannah Date: Sat, 20 May 2017 17:20:47 -0400 Subject: [PATCH] Regen html --- doc/func_timeout.StoppableThread.html | 2 +- doc/func_timeout.dafunc.html | 7 ++++++- doc/func_timeout.exceptions.html | 9 +++++---- doc/func_timeout.html | 14 ++++++++++---- 4 files changed, 22 insertions(+), 10 deletions(-) diff --git a/doc/func_timeout.StoppableThread.html b/doc/func_timeout.StoppableThread.html index a71f666..8532685 100644 --- a/doc/func_timeout.StoppableThread.html +++ b/doc/func_timeout.StoppableThread.html @@ -54,7 +54,7 @@ LICENSE, otherwise it is available at https://gith
Methods defined here:
-
__init__(self, otherThread, exception)
This constructor should always be called with keyword arguments. Arguments are:
+
__init__(self, otherThread, exception, repeatEvery=2.0)
This constructor should always be called with keyword arguments. Arguments are:
 
*group* should be None; reserved for future extension when a ThreadGroup
class is implemented.
diff --git a/doc/func_timeout.dafunc.html b/doc/func_timeout.dafunc.html index 8da7e2a..c2eaac0 100644 --- a/doc/func_timeout.dafunc.html +++ b/doc/func_timeout.dafunc.html @@ -30,7 +30,7 @@ LICENSE, otherwise it is available at https://gith Functions         -
func_set_timeout(timeout, allowOverride=False)
set_timeout - Wrapper to run a function with a given/calculated timeout (max execution time).
+
func_set_timeout(timeout, allowOverride=False)
func_set_timeout - Decorator to run a function with a given/calculated timeout (max execution time).
    Optionally (if #allowOverride is True), adds a paramater, "forceTimeout", to the
    function which, if provided, will override the default timeout for that invocation.
 
@@ -84,10 +84,14 @@ LICENSE, otherwise it is available at https://gith Raises any exceptions #func# would raise, returns what #func# would return (unless timeout is exceeded), in which case it raises FunctionTimedOut
 
@param timeout <float> - Maximum number of seconds to run #func# before terminating
+ 
@param func <function> - The function to call
+ 
@param args    <tuple> - Any ordered arguments to pass to the function
+ 
@param kwargs  <dict/None> - Keyword arguments to pass to the function.
 
+ 
@raises - FunctionTimedOut if #timeout# is exceeded, otherwise anything #func# could raise will be raised
 
If the timeout is exceeded, FunctionTimedOut will be raised within the context of the called function every two seconds until it terminates,
@@ -95,6 +99,7 @@ but will not block the calling thread (a  to return cleanly, but in most cases it will 'just work'.
 
Be careful of code like:
+ 
def myfunc():
    while True:
        try:
diff --git a/doc/func_timeout.exceptions.html b/doc/func_timeout.exceptions.html index 1480418..541d7ec 100644 --- a/doc/func_timeout.exceptions.html +++ b/doc/func_timeout.exceptions.html @@ -41,7 +41,8 @@ LICENSE, otherwise it is available at https://gith @property timedOutArgs - Ordered args to function
@property timedOutKwargs - Keyword args to function
 
-@method retry - R
  +@method retry - Retries the function with same arguments, with option to run with original timeout, no timeout, or a different
+  explicit timeout. @see FunctionTimedOut.retry
   
Method resolution order:
FunctionTimedOut
@@ -56,11 +57,11 @@ Methods defined here:
 
@return <str> - Message
-
retry(self, timeout='__rst')
retry - Retry the timed-out function with same arguments.
+
retry(self, timeout='RETRY_SAME_TIMEOUT')
retry - Retry the timed-out function with same arguments.
 
@param timeout <float/RETRY_SAME_TIMEOUT/None> Default RETRY_SAME_TIMEOUT
    
-    If RETRY_SAME_TIMEOUT : Will retry the function same args, sane timeout
+    If RETRY_SAME_TIMEOUT : Will retry the function same args, same timeout
    If a float/int : Will retry the function same args with provided timeout
    If None : Will retry function same args no timeout
 
@@ -115,6 +116,6 @@ Data descriptors inherited from builtins. Data         -RETRY_SAME_TIMEOUT = '__rst'
+RETRY_SAME_TIMEOUT = 'RETRY_SAME_TIMEOUT'
__all__ = ('FunctionTimedOut', 'RETRY_SAME_TIMEOUT')

\ No newline at end of file diff --git a/doc/func_timeout.html b/doc/func_timeout.html index 1966139..80d89e0 100644 --- a/doc/func_timeout.html +++ b/doc/func_timeout.html @@ -51,7 +51,8 @@ LICENSE, otherwise it is available at https://gith @property timedOutArgs - Ordered args to function
@property timedOutKwargs - Keyword args to function
 
-@method retry - R
  +@method retry - Retries the function with same arguments, with option to run with original timeout, no timeout, or a different
+  explicit timeout. @see FunctionTimedOut.retry
   
Method resolution order:
FunctionTimedOut
@@ -66,11 +67,11 @@ Methods defined here:
 
@return <str> - Message
-
retry(self, timeout='__rst')
retry - Retry the timed-out function with same arguments.
+
retry(self, timeout='RETRY_SAME_TIMEOUT')
retry - Retry the timed-out function with same arguments.
 
@param timeout <float/RETRY_SAME_TIMEOUT/None> Default RETRY_SAME_TIMEOUT
    
-    If RETRY_SAME_TIMEOUT : Will retry the function same args, sane timeout
+    If RETRY_SAME_TIMEOUT : Will retry the function same args, same timeout
    If a float/int : Will retry the function same args with provided timeout
    If None : Will retry function same args no timeout
 
@@ -125,7 +126,7 @@ Data descriptors inherited from builtins. Functions         -
func_set_timeout(timeout, allowOverride=False)
set_timeout - Wrapper to run a function with a given/calculated timeout (max execution time).
+
func_set_timeout(timeout, allowOverride=False)
func_set_timeout - Decorator to run a function with a given/calculated timeout (max execution time).
    Optionally (if #allowOverride is True), adds a paramater, "forceTimeout", to the
    function which, if provided, will override the default timeout for that invocation.
 
@@ -179,10 +180,14 @@ Data descriptors inherited from builtins. Raises any exceptions #func# would raise, returns what #func# would return (unless timeout is exceeded), in which case it raises FunctionTimedOut
 
@param timeout <float> - Maximum number of seconds to run #func# before terminating
+ 
@param func <function> - The function to call
+ 
@param args    <tuple> - Any ordered arguments to pass to the function
+ 
@param kwargs  <dict/None> - Keyword arguments to pass to the function.
 
+ 
@raises - FunctionTimedOut if #timeout# is exceeded, otherwise anything #func# could raise will be raised
 
If the timeout is exceeded, FunctionTimedOut will be raised within the context of the called function every two seconds until it terminates,
@@ -190,6 +195,7 @@ but will not block the calling thread (a  to return cleanly, but in most cases it will 'just work'.
 
Be careful of code like:
+ 
def myfunc():
    while True:
        try: