From: Andre Delfino <adelfino@gmail.com>
Date: Sat, 29 Jun 2019 21:59:49 +0000 (-0300)
Subject: Make StreamHandler.terminator more discoverable (GH-14359)
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=3e6583061cc7bc27305f17500dece8e43b9f4eab;p=python

Make StreamHandler.terminator more discoverable (GH-14359)
---

diff --git a/Doc/library/logging.handlers.rst b/Doc/library/logging.handlers.rst
index 4c1af7cba6..703d66d7ff 100644
--- a/Doc/library/logging.handlers.rst
+++ b/Doc/library/logging.handlers.rst
@@ -48,7 +48,7 @@ and :meth:`flush` methods).
    .. method:: emit(record)
 
       If a formatter is specified, it is used to format the record. The record
-      is then written to the stream with a terminator. If exception information
+      is then written to the stream followed by :attr:`terminator`. If exception information
       is present, it is formatted using :func:`traceback.print_exception` and
       appended to the stream.
 
@@ -70,13 +70,17 @@ and :meth:`flush` methods).
 
       .. versionadded:: 3.7
 
+   .. attribute:: terminator
 
-.. versionchanged:: 3.2
-   The ``StreamHandler`` class now has a ``terminator`` attribute, default
-   value ``'\n'``, which is used as the terminator when writing a formatted
-   record to a stream. If you don't want this newline termination, you can
-   set the handler instance's ``terminator`` attribute to the empty string.
-   In earlier versions, the terminator was hardcoded as ``'\n'``.
+      String used as the terminator when writing a formatted record to a stream.
+      Default value is ``'\n'``.
+
+      If you don't want a newline termination, you can set the handler instance's
+      ``terminator`` attribute to the empty string.
+
+      In earlier versions, the terminator was hardcoded as ``'\n'``.
+
+      .. versionadded:: 3.2
 
 
 .. _file-handler: