[Python-checkins] r66118 - python/trunk/Doc/library/logging.rst
vinay.sajip
python-checkins at python.org
Mon Sep 1 19:44:14 CEST 2008
Author: vinay.sajip
Date: Mon Sep 1 19:44:14 2008
New Revision: 66118
Log:
Bug #3738: Documentation is now more accurate in describing handler close methods.
Modified:
python/trunk/Doc/library/logging.rst
Modified: python/trunk/Doc/library/logging.rst
==============================================================================
--- python/trunk/Doc/library/logging.rst (original)
+++ python/trunk/Doc/library/logging.rst Mon Sep 1 19:44:14 2008
@@ -1504,8 +1504,10 @@
.. 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 @@
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 @@
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)
More information about the Python-checkins
mailing list