diff options
| author | Vinay Sajip <vinay_sajip@yahoo.co.uk> | 2008-09-01 17:44:14 +0000 |
|---|---|---|
| committer | Vinay Sajip <vinay_sajip@yahoo.co.uk> | 2008-09-01 17:44:14 +0000 |
| commit | aa5f873980994d1a216bcbe3d276d6a0b7d4b1cc (patch) | |
| tree | eab334f1dde2b383b4e2dc338cb627844345a241 | |
| parent | e5c1d294b185a9b7aa46067976e6ed2819392269 (diff) | |
| download | cpython-git-aa5f873980994d1a216bcbe3d276d6a0b7d4b1cc.tar.gz | |
Bug #3738: Documentation is now more accurate in describing handler close methods.
| -rw-r--r-- | Doc/library/logging.rst | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst index ff09e08cc4..dac6aeb173 100644 --- a/Doc/library/logging.rst +++ b/Doc/library/logging.rst @@ -1504,8 +1504,10 @@ subclasses. However, the :meth:`__init__` method in subclasses needs to call .. method:: Handler.close() - Tidy up any resources used by the handler. This version does nothing and is - intended to be implemented by subclasses. + Tidy up any resources used by the handler. This version does no output but + removes the handler from an internal list of handlers which is closed when + :func:`shutdown` is called. Subclasses should ensure that this gets called + from overridden :meth:`close` methods. .. method:: Handler.handle(record) @@ -1567,7 +1569,7 @@ and :meth:`flush` methods). Flushes the stream by calling its :meth:`flush` method. Note that the :meth:`close` method is inherited from :class:`Handler` and so does - nothing, so an explicit :meth:`flush` call may be needed at times. + no output, so an explicit :meth:`flush` call may be needed at times. FileHandler @@ -1887,7 +1889,7 @@ extensions for Python installed. source of event log entries. However, if you do this, you will not be able to see the events as you intended in the Event Log Viewer - it needs to be able to access the registry to get the .dll name. The current version does - not do this (in fact it doesn't do anything). + not do this. .. method:: emit(record) |