From: Éric Araujo <merwok@netwok.org>
Date: Thu, 18 Aug 2011 22:44:31 +0000 (+0200)
Subject: Minor improvements to BadZipFile and BadZipfile docs.
X-Git-Tag: v3.3.0a1~1674^2~2^2~7
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=d001ffe7455605219ae47867beb2b8eb643e4493;p=python

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.
---

diff --git a/Doc/library/zipfile.rst b/Doc/library/zipfile.rst
index 3282054485..019a894721 100644
--- a/Doc/library/zipfile.rst
+++ b/Doc/library/zipfile.rst
@@ -30,15 +30,16 @@ The module defines the following items:
 
 .. 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