Mailing List Archive: Python: Bugs

[issue7351] Documentation typos found in "zipfile — Work with ZIP archives"

Index | Next | Previous | View Threaded

report at bugs

Nov 18, 2009, 11:12 AM

Post #1 of 8 (301 views)
Permalink

[issue7351] Documentation typos found in "zipfile — Work with ZIP archives"

New submission from Retro <vinetouu [at] gmail>:

There are some minor typos in the docs. The section zipfile has twp typos:

exception zipfile.BadZipfile
The error raised for bad ZIP files (old name: zipfile.error).

this should be

exception zipfile.BadZipFile
The error raised for bad ZIP files (old name: zipfile.error).

Note: There needs to be a capital F in the exception class name BadZipFile.

There's also a typo in the sentence "Decryption is extremely slow as it
is implemented in native python rather than C." which should be
"Decryption is extremely slow as it is implemented in native Python
rather than C." This sentence is found just above the previous
BadZipfile typo.

Note: The word 'python' is needed to be capitalized.

These typos exist since the creation of the zipfile docs. Please correct
the docs for the selected versions. Thank you.

----------
assignee: georg.brandl
components: Documentation
messages: 95442
nosy: Retro, georg.brandl
severity: normal
status: open
title: Documentation typos found in "zipfile — Work with ZIP archives"
versions: Python 2.6, Python 2.7, Python 3.1, Python 3.2

_______________________________________
Python tracker <report [at] bugs>
<http://bugs.python.org/issue7351>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/list-python-bugs%40lists.gossamer-threads.com

report at bugs

Nov 18, 2009, 11:40 AM

Post #2 of 8 (282 views)
Permalink

[issue7351] Documentation typos found in "zipfile — Work with ZIP archives" [In reply to]

Georg Brandl <georg [at] python> added the comment:

BadZipfile is actually the correct name of the exception.

Fixed the other nit in r76376.

----------
resolution: -> fixed
status: open -> closed

_______________________________________
Python tracker <report [at] bugs>
<http://bugs.python.org/issue7351>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/list-python-bugs%40lists.gossamer-threads.com

report at bugs

Nov 18, 2009, 12:54 PM

Post #3 of 8 (280 views)
Permalink

[issue7351] Documentation typos found in "zipfile — Work with ZIP archives" [In reply to]

Retro <vinetouu [at] gmail> added the comment:

Thanks for upcassing 'Python'.

I have to ask you why are all other classes named in the form of
...ZipFile, like
- exception: LargeZipFile
- class: ZipFile
- class: PyZipFile

Please at least consider of making the class BadZipfile consistent to
other classes and let it be renamed to BadZipFile. Thank you again.

----------
status: closed -> open

_______________________________________
Python tracker <report [at] bugs>
<http://bugs.python.org/issue7351>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/list-python-bugs%40lists.gossamer-threads.com

report at bugs

Nov 19, 2009, 6:23 AM

Post #4 of 8 (269 views)
Permalink

[issue7351] Documentation typos found in "zipfile — Work with ZIP archives" [In reply to]

Retro <vinetouu [at] gmail> added the comment:

I suggest renaming the class from BadZipfile to BadZipFile. We have a
class named LargeZipFile. It would make sence to have the previously
mentioned class named as BadZipFile then. What is your verdict on that?

----------

_______________________________________
Python tracker <report [at] bugs>
<http://bugs.python.org/issue7351>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/list-python-bugs%40lists.gossamer-threads.com

report at bugs

Nov 19, 2009, 6:41 AM

Post #5 of 8 (269 views)
Permalink

[issue7351] Documentation typos found in "zipfile — Work with ZIP archives" [In reply to]

Ezio Melotti <ezio.melotti [at] gmail> added the comment:

The old name could be deprecated and replaced by the right one, but as
Eric Smith mentioned on #python-dev, the class with the old name can't
be removed because - even if unlikely - the object might exist in a pickle.
So we can either live with the wrong name or deprecate it, fix the
places where it's used and live with a deprecated version that can't be
removed.

----------
nosy: +ezio.melotti
priority: -> low

_______________________________________
Python tracker <report [at] bugs>
<http://bugs.python.org/issue7351>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/list-python-bugs%40lists.gossamer-threads.com

report at bugs

Nov 19, 2009, 8:09 AM

Post #6 of 8 (269 views)
Permalink

[issue7351] Documentation typos found in "zipfile — Work with ZIP archives" [In reply to]

Retro <vinetouu [at] gmail> added the comment:

I am merely speaking of renaming the class name from BadZipfile to
BadZipFile.

class BadZipFile(exceptions.Exception):
# etc.

Only the name is fixed at class definition. I am aiming for that in this
bug report. And then every other BadZipfile should be fixed to
BadZipFile. Is that doable?

----------

_______________________________________
Python tracker <report [at] bugs>
<http://bugs.python.org/issue7351>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/list-python-bugs%40lists.gossamer-threads.com

report at bugs

Nov 19, 2009, 8:24 AM

Post #7 of 8 (268 views)
Permalink

[issue7351] Documentation typos found in "zipfile — Work with ZIP archives" [In reply to]

Ezio Melotti <ezio.melotti [at] gmail> added the comment:

It might be doable for Python and its stdlib, but all the programs and
modules that are using the old name will start raising errors if they
don't find the old name anymore.
If the old name is deprecated for at least one Python version (e.g.
2.7/3.2), these programs can fix it and then, after a few versions (e.g.
3.3), the old name can finally be removed.
There is still the pickle issue, even if IMHO it's so unlikely that it
shouldn't be relevant.

----------

_______________________________________
Python tracker <report [at] bugs>
<http://bugs.python.org/issue7351>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/list-python-bugs%40lists.gossamer-threads.com

report at bugs

Nov 19, 2009, 9:48 AM

Post #8 of 8 (268 views)
Permalink

[issue7351] Documentation typos found in "zipfile — Work with ZIP archives" [In reply to]

Retro <vinetouu [at] gmail> added the comment:

I made a patch which fixes the BadZipfile issue. Please take a look and
decide whether you'll toss it or use it. Maybe it'll come handy some
other time in the future.

----------
keywords: +patch
Added file: http://bugs.python.org/file15365/zipfile-patch.diff

_______________________________________
Python tracker <report [at] bugs>
<http://bugs.python.org/issue7351>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/list-python-bugs%40lists.gossamer-threads.com

Index | Next | Previous | View Threaded

Interested in having your list archived? Contact Gossamer Threads