Update ChangeLog link, and add link to pydoc. Regenerate pydoc for 1.0.1
This commit is contained in:
parent
08052219f1
commit
edfc9b8d4a
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -6,7 +6,7 @@
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
||||
<tr bgcolor="#7799ee">
|
||||
<td valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong>func_timeout</strong></big></big> (version 1.0.0)</font></td
|
||||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong>func_timeout</strong></big></big> (version 1.0.1)</font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href="func_timeout.html">index</a></font></td></tr></table>
|
||||
<p><tt>Copyright (c) 2016 Tim Savannah All Rights Reserved.<br>
|
||||
@ -103,7 +103,18 @@ Data descriptors inherited from <a href="builtins.html#BaseException">builtins.B
|
||||
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
|
||||
|
||||
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
|
||||
<td width="100%"><dl><dt><a name="-func_timeout"><strong>func_timeout</strong></a>(timeout, func, args=(), kwargs=None)</dt></dl>
|
||||
<td width="100%"><dl><dt><a name="-func_timeout"><strong>func_timeout</strong></a>(timeout, func, args=(), kwargs=None)</dt><dd><tt>func_timeout - Runs the given function for up to #timeout# seconds.<br>
|
||||
<br>
|
||||
Raises any exceptions #func# would raise, returns what #func# would return (unless timeout is exceeded), in which case it raises <a href="#FunctionTimedOut">FunctionTimedOut</a><br>
|
||||
<br>
|
||||
@param timeout <float> - Maximum number of seconds to run #func# before terminating<br>
|
||||
@param func <function> - The function to call<br>
|
||||
@param args <tuple> - Any ordered arguments to pass to the function<br>
|
||||
@param kwargs <dict/None> - Keyword arguments to pass to the function.<br>
|
||||
<br>
|
||||
@raises - <a href="#FunctionTimedOut">FunctionTimedOut</a> if #timeout# is exceeded, otherwise anything #func# could raise will be raised<br>
|
||||
<br>
|
||||
@return - The return value that #func# gives</tt></dd></dl>
|
||||
</td></tr></table><p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#55aa55">
|
||||
@ -112,5 +123,5 @@ Data descriptors inherited from <a href="builtins.html#BaseException">builtins.B
|
||||
|
||||
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
|
||||
<td width="100%"><strong>__all__</strong> = ('func_timeout', 'FunctionTimedOut')<br>
|
||||
<strong>__version_tuple__</strong> = (1, 0, 0)</td></tr></table>
|
||||
<strong>__version_tuple__</strong> = (1, 0, 1)</td></tr></table>
|
||||
</body></html>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user