[Python-checkins] cpython (3.2): Minor improvements to BadZipFile and BadZipfile docs.

[eric.araujo]

http://hg.python.org/cpython/rev/b0038dd0b7ca
changeset:   71925:b0038dd0b7ca
branch:      3.2
user:        Éric Araujo <merwok at netwok.org>
date:        Fri Aug 19 00:44:31 2011 +0200
summary:
  Minor improvements to BadZipFile and BadZipfile docs.

I made the doc for the compat alias BadZipfile shorter and used a
directive to document deprecation.

I figured there was no point of talking about zipfile.error (“the old
name” that’s older than the other old name BadZipfile) in the 3.x docs
so I just removed it.

files:
  Doc/library/zipfile.rst |  7 ++++---
  1 files changed, 4 insertions(+), 3 deletions(-)


diff --git a/Doc/library/zipfile.rst b/Doc/library/zipfile.rst
--- a/Doc/library/zipfile.rst
+++ b/Doc/library/zipfile.rst
@@ -30,15 +30,16 @@
 
 .. exception:: BadZipFile
 
-   The error raised for bad ZIP files (old name: ``zipfile.error``).
+   The error raised for bad ZIP files.
 
    .. versionadded:: 3.2
 
 
 .. exception:: BadZipfile
 
-   This is an alias for :exc:`BadZipFile` that exists for compatibility with
-   Python versions prior to 3.2.  Usage is deprecated.
+   Alias of :exc:`BadZipFile`, for compatibility with older Python versions.
+
+   .. deprecated:: 3.2
 
 
 .. exception:: LargeZipFile

-- 
Repository URL: http://hg.python.org/cpython