upstream/certbot
1
0
Fork 0
mirror of https://github.com/certbot/certbot.git synced 2026-06-13 18:50:20 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Improve interface documentation

Browse source
This commit is contained in:
Adrien Ferrand 2019-02-22 22:38:39 +01:00
parent edfa3cdcdf
commit cececb0174
1 changed files with 2 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
certbot/interfaces.py
View file

@ -160,16 +160,13 @@ class IAuthenticator(IPlugin):
:returns: `collections.Iterable` of ACME
:class:`~acme.challenges.ChallengeResponse` instances corresponding to each provided
:class:`~acme.challenges.Challenge`. Not returning all expected
class:`~acme.challenges.ChallengeResponse`, will instruct Certbot that some or all
:class:`~acme.challenges.Challenge` cannot be fulfilled, and this will fail
the authorization process.
:class:`~acme.challenges.Challenge`.
:rtype: :class:`collections.Iterable` of
:class:`acme.challenges.ChallengeResponse`,
where responses are required to be returned in
the same order as corresponding input challenges
:raises .PluginError: If challenges cannot be performed
:raises .PluginError: If some or all challenges cannot be performed
"""