classification
Title: error in documentation of distutils.archive_util.make_zipfile
Type: Stage: resolved
Components: Distutils, Documentation Versions: Python 3.1, Python 3.2, Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: eric.araujo Nosy List: docs@python, eli.bendersky, eric.araujo, tarek
Priority: normal Keywords: easy, patch

Created on 2010-12-13 12:47 by eli.bendersky, last changed 2010-12-15 20:40 by eric.araujo. This issue is now closed.

Files
File name Uploaded Description Edit
issue10693.py32.1.patch eli.bendersky, 2010-12-15 18:37
Messages (3)
msg123872 - (view) Author: Eli Bendersky (eli.bendersky) * (Python committer) Date: 2010-12-13 12:47
The documentation of:

distutils.archive_util.make_zipfile(base_name, base_dir[, verbose=0, dry_run=0]) 

Says:

  Create a zip file from all files in and under base_dir. The output zip file will be named base_dir + .zip. 

This isn't correct, as the name of the output file is "base_name + .zip"

The error exists both in the docstring of make_zipfile in distutils/archive_util.py and in the ReST documentation of the function
msg124036 - (view) Author: Eli Bendersky (eli.bendersky) * (Python committer) Date: 2010-12-15 18:37
Attaching a fix for Doc/distutils/apiref.rst and Lib/distutils/archive_util.py in Python 3.2

If it's OK I will backport to other versions as well.
msg124066 - (view) Author: √Čric Araujo (eric.araujo) * (Python committer) Date: 2010-12-15 20:40
Patch extended to cover shutil, which has gained _make_{tar,zip}file in 2.7 and 3.2, and committed in all three branches in r87277 to r87279.

Will be fixed in distutils2 the next time I synchronize d2._backport.shutil.
History
Date User Action Args
2010-12-15 20:40:15eric.araujosetstatus: open -> closed

assignee: tarek -> eric.araujo
versions: + Python 3.1, - Python 2.6
nosy: tarek, eric.araujo, eli.bendersky, docs@python
messages: + msg124066
resolution: fixed
stage: resolved
2010-12-15 18:37:46eli.benderskysetfiles: + issue10693.py32.1.patch

messages: + msg124036
keywords: + patch
nosy: tarek, eric.araujo, eli.bendersky, docs@python
2010-12-13 12:47:11eli.benderskycreate