starred/certbot
1
0
Fork 0
mirror of https://github.com/certbot/certbot.git synced 2026-08-03 03:32:13 +02:00
Code Issues Packages Projects Releases Wiki Activity

Fix documentation build failures (#5068)

Browse Source 
* sphinxify error_handler docs
This commit is contained in:
Brad Warren
2017-08-31 16:35:53 -07:00
committed by GitHub
parent 7cb8c1264f
commit bbf397a9f9
1 changed files with 10 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
certbot/error_handler.py
+4 -3
View File
@@ -29,7 +29,8 @@ class ErrorHandler(object):
"""Context manager for running code that must be cleaned up on failure. """Context manager for running code that must be cleaned up on failure.
The context manager allows you to register functions that will be called The context manager allows you to register functions that will be called
when an exception (excluding SystemExit) or signal is encountered. Usage: when an exception (excluding SystemExit) or signal is encountered.
Usage::
handler = ErrorHandler(cleanup1_func, *cleanup1_args, **cleanup1_kwargs) handler = ErrorHandler(cleanup1_func, *cleanup1_args, **cleanup1_kwargs)
handler.register(cleanup2_func, *cleanup2_args, **cleanup2_kwargs) handler.register(cleanup2_func, *cleanup2_args, **cleanup2_kwargs)
@@ -37,7 +38,7 @@ class ErrorHandler(object):
with handler: with handler:
do_something() do_something()
Or for one cleanup function: Or for one cleanup function::
with ErrorHandler(func, args, kwargs): with ErrorHandler(func, args, kwargs):
do_something() do_something()
@@ -84,7 +85,7 @@ class ErrorHandler(object):
return retval return retval
def register(self, func, *args, **kwargs): def register(self, func, *args, **kwargs):
"""Sets func to be called with *args and **kwargs during cleanup """Sets func to be run with the given arguments during cleanup.
:param function func: function to be called in case of an error :param function func: function to be called in case of an error