Skip to content

Commit 7c1e4d9

Browse files
committed
chore: update docstring for auth method
1 parent b9cb54b commit 7c1e4d9

File tree

1 file changed

+1
-21
lines changed

1 file changed

+1
-21
lines changed

Lib/poplib.py

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -221,27 +221,7 @@ def pass_(self, pswd):
221221
def auth(self, mechanism, authobject=None, initial_response=None):
222222
"""Authenticate to the POP3 server using the AUTH command (RFC 5034).
223223
224-
Parameters
225-
----------
226-
mechanism : str
227-
SASL mechanism name, e.g. 'PLAIN', 'CRAM-MD5'.
228-
authobject : callable, optional
229-
Challenge-response callback. Called with a `bytes` challenge
230-
(already base64-decoded) and must return `bytes` or `str`.
231-
Return ``b'*'`` to abort the exchange.
232-
initial_response : bytes or str, optional
233-
Initial client response to send immediately after the AUTH command.
234-
If you supply this you must **not** supply *authobject*.
235-
236-
Returns
237-
-------
238-
bytes
239-
The server's final line (``+OK ...`` or ``-ERR ...``).
240-
241-
Raises
242-
------
243-
ValueError
244-
If both *authobject* and *initial_response* are given.
224+
Result is 'response'.
245225
"""
246226
if authobject is not None and initial_response is not None:
247227
raise ValueError('authobject and initial_response are mutually exclusive')

0 commit comments

Comments
 (0)