diff --git a/doc/func_timeout.dafunc.html b/doc/func_timeout.dafunc.html index b0f3be1..62cdf4e 100644 --- a/doc/func_timeout.dafunc.html +++ b/doc/func_timeout.dafunc.html @@ -38,34 +38,34 @@     If #timeout is provided as a lambda/function, it will be called
      prior to each invocation of the decorated function to calculate the timeout to be used
      for that call, based on the arguments passed to the decorated function.
-      

      For example, you may have a "processData" function whose execution time
-      depends on the number of "data" elements, so you may want a million elements to have a 
+      depends on the number of "data" elements, so you may want a million elements to have a
      much higher timeout than seven elements.)
 
    If #allowOverride is True AND a kwarg of "forceTimeout" is passed to the wrapped function, that timeout
     will be used for that single call.
 
-@param timeout <float OR lambda/function> - 
+@param timeout <float OR lambda/function> -
 
    **If float:**
        Default number of seconds max to allow function to execute
          before throwing FunctionTimedOut
-    

    **If lambda/function:
 
         If a function/lambda is provided, it will be called for every
-          invocation of the decorated function (unless #allowOverride=True and "forceTimeout" was passed) 
+          invocation of the decorated function (unless #allowOverride=True and "forceTimeout" was passed)
          to determine the timeout to use based on the arguments to the decorated function.
 
            The arguments as passed into the decorated function will be passed to this function.
             They either must match exactly to what the decorated function has, OR
              if you prefer to get the *args (list of ordered args) and **kwargs ( key : value  keyword args form),
              define your calculate function like:
-                

                def calculateTimeout(*args, **kwargs):
                    ...
-            

              or lambda like:
 
                calculateTimeout = lambda *args, **kwargs : ...
diff --git a/doc/func_timeout.exceptions.html b/doc/func_timeout.exceptions.html index ae9ec3d..7b2b81c 100644 --- a/doc/func_timeout.exceptions.html +++ b/doc/func_timeout.exceptions.html @@ -62,7 +62,7 @@
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, same timeout
    If a float/int : Will retry the function same args with provided timeout
    If None : Will retry function same args no timeout
diff --git a/doc/func_timeout.html b/doc/func_timeout.html index 4a49782..5bd98fb 100644 --- a/doc/func_timeout.html +++ b/doc/func_timeout.html @@ -6,8 +6,8 @@
 
- 
func_timeout (version 4.3.0)
index
-

Copyright (c) 2016, 2017 Tim Savannah All Rights Reserved.
+ 
func_timeout (version 4.3.1)
index +

Copyright (c) 2016, 2017, 2019 Tim Savannah All Rights Reserved.
 
Licensed under the Lesser GNU Public License Version 3, LGPLv3. You should have recieved a copy of this with the source distribution as
LICENSE, otherwise it is available at https://github.com/kata198/func_timeout/LICENSE

@@ -80,7 +80,7 @@
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, same timeout
    If a float/int : Will retry the function same args with provided timeout
    If None : Will retry function same args no timeout
@@ -313,34 +313,34 @@     If #timeout is provided as a lambda/function, it will be called
      prior to each invocation of the decorated function to calculate the timeout to be used
      for that call, based on the arguments passed to the decorated function.
-      

      For example, you may have a "processData" function whose execution time
-      depends on the number of "data" elements, so you may want a million elements to have a 
+      depends on the number of "data" elements, so you may want a million elements to have a
      much higher timeout than seven elements.)
 
    If #allowOverride is True AND a kwarg of "forceTimeout" is passed to the wrapped function, that timeout
     will be used for that single call.
 
-@param timeout <float OR lambda/function> - 
+@param timeout <float OR lambda/function> -
 
    **If float:**
        Default number of seconds max to allow function to execute
          before throwing FunctionTimedOut
-    

    **If lambda/function:
 
         If a function/lambda is provided, it will be called for every
-          invocation of the decorated function (unless #allowOverride=True and "forceTimeout" was passed) 
+          invocation of the decorated function (unless #allowOverride=True and "forceTimeout" was passed)
          to determine the timeout to use based on the arguments to the decorated function.
 
            The arguments as passed into the decorated function will be passed to this function.
             They either must match exactly to what the decorated function has, OR
              if you prefer to get the *args (list of ordered args) and **kwargs ( key : value  keyword args form),
              define your calculate function like:
-                

                def calculateTimeout(*args, **kwargs):
                    ...
-            

              or lambda like:
 
                calculateTimeout = lambda *args, **kwargs : ...
@@ -383,5 +383,5 @@         __all__ = ('func_timeout', 'func_set_timeout', 'FunctionTimedOut', 'StoppableThread')
-__version_tuple__ = (4, 3, 0) +__version_tuple__ = (4, 3, 1)

\ No newline at end of file