1
0
mirror of https://github.com/certbot/certbot.git synced 2026-01-21 19:01:07 +03:00

moved info back to docstrings

This commit is contained in:
Noah Swartz
2015-10-26 13:24:42 -07:00
parent 46ac0169b5
commit 788cb5fc99
2 changed files with 14 additions and 15 deletions

View File

@@ -26,12 +26,15 @@ logger = logging.getLogger(__name__)
class Authenticator(common.Plugin):
"""Manual Authenticator.
.. todo:: Support for `~.challenges.DVSNI`.
This plugin requires user's manual intervention in setting up a HTTP
server for solving SimpleHTTP challenges and thus does not need to be
run as a privilidged process. Alternatively shows instructions on how
to use Python's built-in HTTP server and, in case of HTTPS, openssl
binary for temporary key/certificate generation.
"""
zope.interface.implements(interfaces.IAuthenticator)
zope.interface.classProvides(interfaces.IPluginFactory)
hidden = True
# hidden = True
description = "Manually Edit Your Configuration"
@@ -81,12 +84,7 @@ s.serve_forever()" """
pass # pragma: no cover
def more_info(self): # pylint: disable=missing-docstring,no-self-use
return """\
This plugin requires user's manual intervention in setting up a HTTP
server for solving SimpleHTTP challenges and thus does not need to be
run as a privilidged process. Alternatively shows instructions on how
to use Python's built-in HTTP server and, in case of HTTPS, openssl
binary for temporary key/certificate generation.""".replace("\n", "")
return self.__doc__.replace("\n ", " ")
def get_chall_pref(self, domain):
# pylint: disable=missing-docstring,no-self-use,unused-argument

View File

@@ -134,8 +134,13 @@ def supported_challenges_validator(data):
class Authenticator(common.Plugin):
"""Standalone Authenticator."""
"""Standalone Authenticator.
This authenticator creates its own ephemeral TCP listener on the
necessary port in order to respond to incoming DVSNI and SimpleHTTP
challenges from the certificate authority. Therefore, it does not
rely on any existing server program.
"""
zope.interface.implements(interfaces.IAuthenticator)
zope.interface.classProvides(interfaces.IPluginFactory)
@@ -176,11 +181,7 @@ class Authenticator(common.Plugin):
self.conf("supported-challenges").split(","))
def more_info(self): # pylint: disable=missing-docstring
return """\
This authenticator creates its own ephemeral TCP listener on the
necessary port in order to respond to incoming DVSNI and SimpleHTTP
challenges from the certificate authority. Therefore, it does not
rely on any existing server program.""".replace("\n", "")
return self.__doc__.replace("\n ", " ")
def prepare(self): # pylint: disable=missing-docstring
pass