diff --git a/ChangeLog b/ChangeLog index d0f84b5..8b5930c 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,4 @@ * 1.0.1 - Mar 15 2016 - Remove debugging print - Note that it has been explicitly tested on 2.7, 3.4, and 3.5 in README. +- Add link to pydoc in README diff --git a/README.md b/README.md index 580668b..b02a080 100644 --- a/README.md +++ b/README.md @@ -54,4 +54,6 @@ Support I've tested func\_timeout with python 2.7, 3.4, and 3.5. It should work on other versions as well. -ChangeLog can be found at https://github.com/kata198/func_timeout/ChangeLog +ChangeLog can be found at https://raw.githubusercontent.com/kata198/func_timeout/master/ChangeLog + +Pydoc can be found at: http://htmlpreview.github.io/?https://github.com/kata198/func_timeout/blob/master/doc/func_timeout.html?vers=1 diff --git a/README.rst b/README.rst index 3ef44d9..80c0b43 100644 --- a/README.rst +++ b/README.rst @@ -73,4 +73,6 @@ Support I've tested func\_timeout with python 2.7, 3.4, and 3.5. It should work on other versions as well. -ChangeLog can be found at https://github.com/kata198/func_timeout/ChangeLog +ChangeLog can be found at https://raw.githubusercontent.com/kata198/func_timeout/master/ChangeLog + +Pydoc can be found at: http://htmlpreview.github.io/?https://github.com/kata198/func_timeout/blob/master/doc/func_timeout.html?vers=1 diff --git a/doc/func_timeout.html b/doc/func_timeout.html index 569eb76..9ac4ce2 100644 --- a/doc/func_timeout.html +++ b/doc/func_timeout.html @@ -6,7 +6,7 @@  
func_timeout (version 1.0.1)
 
- 
func_timeout (version 1.0.0)		index

Copyright (c) 2016 Tim Savannah All Rights Reserved.
@@ -103,7 +103,18 @@ Data descriptors inherited from builtins.B Functions         -

func_timeout(timeout, func, args=(), kwargs=None)
+
func_timeout(timeout, func, args=(), kwargs=None)
func_timeout - Runs the given function for up to #timeout# seconds.
+ 
+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
+ 
+@return - The return value that #func# gives

@@ -112,5 +123,5 @@ Data descriptors inherited from builtins.B
        __all__ = ('func_timeout', 'FunctionTimedOut')
-__version_tuple__ = (1, 0, 0)
+__version_tuple__ = (1, 0, 1)