From: Éric Araujo Date: Wed, 15 Dec 2010 20:26:30 +0000 (+0000) Subject: Fix wrong name in docstring and doc (#10693). Original patch by Eli Bendersky. X-Git-Tag: v3.2b2~74 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=4433a5fdc04bf0ec31030af91e74706734fa02e7;p=python Fix wrong name in docstring and doc (#10693). Original patch by Eli Bendersky. --- diff --git a/Doc/distutils/apiref.rst b/Doc/distutils/apiref.rst index 8a68417433..a7dc68e3a9 100644 --- a/Doc/distutils/apiref.rst +++ b/Doc/distutils/apiref.rst @@ -888,7 +888,7 @@ tarballs or zipfiles. .. function:: make_zipfile(base_name, base_dir[, verbose=0, dry_run=0]) Create a zip file from all files in and under *base_dir*. The output zip file - will be named *base_dir* + :file:`.zip`. Uses either the :mod:`zipfile` Python + will be named *base_name* + :file:`.zip`. Uses either the :mod:`zipfile` Python module (if available) or the InfoZIP :file:`zip` utility (if installed and found on the default search path). If neither tool is available, raises :exc:`DistutilsExecError`. Returns the name of the output zip file. diff --git a/Lib/distutils/archive_util.py b/Lib/distutils/archive_util.py index 16164c7f1f..6dd0445dbe 100644 --- a/Lib/distutils/archive_util.py +++ b/Lib/distutils/archive_util.py @@ -68,7 +68,7 @@ def make_tarball(base_name, base_dir, compress="gzip", verbose=0, dry_run=0): def make_zipfile(base_name, base_dir, verbose=0, dry_run=0): """Create a zip file from all the files under 'base_dir'. - The output zip file will be named 'base_dir' + ".zip". Uses either the + The output zip file will be named 'base_name' + ".zip". Uses either the "zipfile" Python module (if available) or the InfoZIP "zip" utility (if installed and found on the default search path). If neither tool is available, raises DistutilsExecError. Returns the name of the output zip diff --git a/Lib/shutil.py b/Lib/shutil.py index 44c8ac37a2..b8086336cb 100644 --- a/Lib/shutil.py +++ b/Lib/shutil.py @@ -370,7 +370,7 @@ def _make_tarball(base_name, base_dir, compress="gzip", verbose=0, dry_run=0, archive that is being built. If not provided, the current owner and group will be used. - The output tar file will be named 'base_dir' + ".tar", possibly plus + The output tar file will be named 'base_name' + ".tar", possibly plus the appropriate compression extension (".gz", or ".bz2"). Returns the output filename. @@ -440,7 +440,7 @@ def _call_external_zip(base_dir, zip_filename, verbose=False, dry_run=False): def _make_zipfile(base_name, base_dir, verbose=0, dry_run=0, logger=None): """Create a zip file from all the files under 'base_dir'. - The output zip file will be named 'base_dir' + ".zip". Uses either the + The output zip file will be named 'base_name' + ".zip". Uses either the "zipfile" Python module (if available) or the InfoZIP "zip" utility (if installed and found on the default search path). If neither tool is available, raises ExecError. Returns the name of the output zip