diff --git a/doc/func_timeout.exceptions.html b/doc/func_timeout.exceptions.html index 7b2b81c..98944ef 100644 --- a/doc/func_timeout.exceptions.html +++ b/doc/func_timeout.exceptions.html @@ -53,7 +53,19 @@
Methods defined here:
-
__init__(self, msg='', timedOutAfter=None, timedOutFunction=None, timedOutArgs=None, timedOutKwargs=None)
Initialize self.  See help(type(self)) for accurate signature.
+
__init__(self, msg='', timedOutAfter=None, timedOutFunction=None, timedOutArgs=None, timedOutKwargs=None)
__init__ - Create this exception type.
+ 
+    You should not need to do this outside of testing, it will be created by the func_timeout API
+ 
+        @param msg <str> - A predefined message, otherwise we will attempt to generate one from the other arguments.
+ 
+        @param timedOutAfter <None/float> - Number of seconds before timing-out. Filled-in by API, None will produce "Unknown"
+ 
+        @param timedOutFunction <None/function> - Reference to the function that timed-out. Filled-in by API." None will produce "Unknown Function"
+ 
+        @param timedOutArgs <None/tuple/list> - List of fixed-order arguments ( *args ), or None for no args.
+ 
+        @param timedOutKwargs <None/dict> - Dict of keyword arg ( **kwargs ) names to values, or None for no kwargs.
getMsg(self)
getMsg - Generate a default message based on parameters to FunctionTimedOut exception'
 
diff --git a/doc/func_timeout.html b/doc/func_timeout.html index 0f59aac..def2f55 100644 --- a/doc/func_timeout.html +++ b/doc/func_timeout.html @@ -6,7 +6,7 @@
 
- 
func_timeout (version 4.3.4)		index
+ 
func_timeout (version 4.3.5)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
@@ -71,7 +71,19 @@

Methods defined here:
-
__init__(self, msg='', timedOutAfter=None, timedOutFunction=None, timedOutArgs=None, timedOutKwargs=None)
Initialize self.  See help(type(self)) for accurate signature.
+
__init__(self, msg='', timedOutAfter=None, timedOutFunction=None, timedOutArgs=None, timedOutKwargs=None)
__init__ - Create this exception type.
+ 
+    You should not need to do this outside of testing, it will be created by the func_timeout API
+ 
+        @param msg <str> - A predefined message, otherwise we will attempt to generate one from the other arguments.
+ 
+        @param timedOutAfter <None/float> - Number of seconds before timing-out. Filled-in by API, None will produce "Unknown"
+ 
+        @param timedOutFunction <None/function> - Reference to the function that timed-out. Filled-in by API." None will produce "Unknown Function"
+ 
+        @param timedOutArgs <None/tuple/list> - List of fixed-order arguments ( *args ), or None for no args.
+ 
+        @param timedOutKwargs <None/dict> - Dict of keyword arg ( **kwargs ) names to values, or None for no kwargs.
getMsg(self)
getMsg - Generate a default message based on parameters to FunctionTimedOut exception'
 
@@ -383,5 +395,5 @@         __all__ = ('func_timeout', 'func_set_timeout', 'FunctionTimedOut', 'StoppableThread')
-__version_tuple__ = (4, 3, 4) +__version_tuple__ = (4, 3, 5)

\ No newline at end of file