From b48adecbd68442708f74c57779c4bbce80fec7cd Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Tue, 31 Mar 2009 19:10:35 +0000 Subject: [PATCH] #1096310: document usage of sys.__std*__ a bit better. --- Doc/library/sys.rst | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst index 30555c824b4..6d02109e37e 100644 --- a/Doc/library/sys.rst +++ b/Doc/library/sys.rst @@ -871,9 +871,14 @@ always available. __stderr__ These objects contain the original values of ``stdin``, ``stderr`` and - ``stdout`` at the start of the program. They are used during finalization, and - could be useful to restore the actual files to known working file objects in - case they have been overwritten with a broken object. + ``stdout`` at the start of the program. They are used during finalization, + and could be useful to print to the actual standard stream no matter if the + ``sys.std*`` object has been redirected. + + It can also be used to restore the actual files to known working file objects + in case they have been overwritten with a broken object. However, the + preferred way to do this is to explicitly save the previous stream before + replacing it, and restore the saved object. .. data:: tracebacklimit