clarify a logging handler docstring

This commit is contained in:
Ryan Petrello
2017-02-09 15:16:28 -05:00
parent 1b9a2e4a36
commit cee0b29fef

View File

@@ -118,9 +118,13 @@ class BaseHTTPSHandler(logging.Handler):
def emit(self, record):
"""
Emit a log record. When ``self.async`` is True, returns a list of
Emit a log record. Returns a list of zero or more
``concurrent.futures.Future`` objects.
When ``self.async`` is True, the list will contain one
Future object for each HTTP request made. When ``self.async`` is
False, the list will be empty.
See:
https://docs.python.org/3/library/concurrent.futures.html#future-objects
http://pythonhosted.org/futures/