[Docutils-checkins] SF.net SVN: docutils:[7423] trunk/docutils

[<mi...@us...>]

Revision: 7423
          http://docutils.svn.sourceforge.net/docutils/?rev=7423&view=rev
Author:   milde
Date:     2012-05-03 11:01:54 +0000 (Thu, 03 May 2012)
Log Message:
-----------
Documentation update.

Modified Paths:
--------------
    trunk/docutils/RELEASE-NOTES.txt
    trunk/docutils/docutils/error_reporting.py

Modified: trunk/docutils/RELEASE-NOTES.txt
===================================================================
--- trunk/docutils/RELEASE-NOTES.txt	2012-05-03 10:55:30 UTC (rev 7422)
+++ trunk/docutils/RELEASE-NOTES.txt	2012-05-03 11:01:54 UTC (rev 7423)
@@ -34,12 +34,13 @@
   Roadmap:
 
   :0.10: change of default behaviour to the equivalent of
-         ``handle_io_errors=False`` and deprecation of the
-         `handle_io_errors` option,
-  :0.11: deprecation warning to stderr if FileInput/FileOutput
-         is called with `handle_io_errors`,
-  :0.12: ignore ``handle_io_errors=True``,
-  :0.13: remove the `handle_io_errors` option.
+         ``handle_io_errors=False``,
+         ignore and deprecate the `handle_io_errors` option.
+         (allows us to clean up Docutils code and remove the error handling
+          code from the FileInput/FileOutput classes)
+  :0.10 + n:   deprecation warning to stderr if FileInput/FileOutput
+               is called with `handle_io_errors`,
+  :0.10 + n+1: remove the `handle_io_errors` option.
 
 
 Changes Since 0.9

Modified: trunk/docutils/docutils/error_reporting.py
===================================================================
--- trunk/docutils/docutils/error_reporting.py	2012-05-03 10:55:30 UTC (rev 7422)
+++ trunk/docutils/docutils/error_reporting.py	2012-05-03 11:01:54 UTC (rev 7423)
@@ -140,11 +140,10 @@
                  decoding_errors='replace'):
         """
         :Parameters:
-            - `stream`: a file-like object (which is written to),
-                        a string (opended as a file),
-                        `None` (bind to `sys.stderr`; default).
-                        If evaluating to `False` (but not `None`),
-                        write() requests are ignored.
+            - `stream`: a file-like object,
+                        a string (path to a file),
+                        `None` (write to `sys.stderr`, default), or
+                        evaluating to `False` (write() requests are ignored).
             - `encoding`: `stream` text encoding. Guessed if None.
             - `encoding_errors`: how to treat encoding errors.
         """

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.