[Python-checkins] distutils2: Fix a variety of typos and wording issues
tarek.ziade
python-checkins at python.org
Thu Jun 24 10:05:21 CEST 2010
tarek.ziade pushed 1f70960d6c8d to distutils2:
http://hg.python.org/distutils2/rev/1f70960d6c8d
changeset: 222:1f70960d6c8d
user: ?ric Araujo <merwok at netwok.org>
date: Fri Jun 11 20:07:14 2010 +0200
summary: Fix a variety of typos and wording issues
files: docs/design/pep-0376.txt, docs/design/wiki.rst, docs/source/metadata.rst, src/DEVNOTES.txt, src/README.txt, src/distutils2/README, src/distutils2/_backport/pkgutil.py, src/distutils2/_backport/sysconfig.cfg, src/distutils2/metadata.py, src/distutils2/tests/test_bdist.py, src/distutils2/util.py, src/runtests.py, src/setup.py
diff --git a/docs/design/pep-0376.txt b/docs/design/pep-0376.txt
--- a/docs/design/pep-0376.txt
+++ b/docs/design/pep-0376.txt
@@ -402,7 +402,7 @@
``.egg-info`` directory that contains a PKG-INFO that matches `name`
for the `name` metadata.
- Notice that there should be at most one result. The first result founded
+ Notice that there should be at most one result. The first result found
is returned. If the directory is not found, returns None.
- ``get_file_users(path)`` -> iterator of ``Distribution`` instances.
diff --git a/docs/design/wiki.rst b/docs/design/wiki.rst
--- a/docs/design/wiki.rst
+++ b/docs/design/wiki.rst
@@ -399,7 +399,7 @@
the folder hierarchy from the module until we find a setup.cfg? A setup.cfg is
necessary if you use distutils2, is it not?
- -> information founded in setup.cfg will be put in the *FILES* file upon
+ -> information found in setup.cfg will be put in the *FILES* file upon
installation in the egg-info directory.
IOW in the unbuit-egg case, we would need to create that dir, then use
pkgutil APIs.
diff --git a/docs/source/metadata.rst b/docs/source/metadata.rst
--- a/docs/source/metadata.rst
+++ b/docs/source/metadata.rst
@@ -17,7 +17,7 @@
Reading metadata
================
-The :class:`DistributionMetadata` class can be instanciated with the path of
+The :class:`DistributionMetadata` class can be instantiated with the path of
the metadata file, and provides a dict-like interface to the values::
>>> from distutils2.metadata import DistributionMetadata
@@ -32,7 +32,7 @@
["pywin32; sys.platform == 'win32'", "Sphinx"]
The fields that supports environment markers can be automatically ignored if
-the object is instanciated using the ``platform_dependant`` option.
+the object is instantiated using the ``platform_dependant`` option.
:class:`DistributionMetadata` will interpret in the case the markers and will
automatically remove the fields that are not compliant with the running
environment. Here's an example under Mac OS X. The win32 dependency
@@ -71,15 +71,15 @@
>>> metadata.write('/to/my/PKG-INFO')
The class will pick the best version for the metadata, depending on the values
-provided. If all the values provided exists in all versions, teh class will
-used :attr:`metadata.PKG_INFO_PREFERRED_VERSION`. It is set by default to 1.0.
+provided. If all the values provided exist in all versions, the class will
+use :attr:`metadata.PKG_INFO_PREFERRED_VERSION`. It is set by default to 1.0.
Conflict checking and best version
==================================
Some fields in PEP 345 have to follow a version scheme in their versions
-predicate. When the scheme is violated, a warning is emited::
+predicate. When the scheme is violated, a warning is emitted::
>>> from distutils2.metadata import DistributionMetadata
>>> metadata = DistributionMetadata()
diff --git a/src/DEVNOTES.txt b/src/DEVNOTES.txt
--- a/src/DEVNOTES.txt
+++ b/src/DEVNOTES.txt
@@ -3,8 +3,8 @@
- Distutils2 runs from 2.4 to 3.2 (3.x not implemented yet), so
make sure you don't use a syntax that doesn't work under
- a specific Python version.
+ one of these Python versions.
- Always run tests.sh before you push a change. This implies
- that you have all Python versions installed.
+ that you have all Python versions installed from 2.4 to 2.6.
diff --git a/src/README.txt b/src/README.txt
--- a/src/README.txt
+++ b/src/README.txt
@@ -2,7 +2,7 @@
Distutils2
==========
-Welcome to Distutils2 !
+Welcome to Distutils2!
Distutils2 is the new version of Distutils. It's not backward compatible with
Distutils but provides more features, and implement most new packaging
@@ -10,6 +10,6 @@
See the documentation at http://packages.python.org/Distutils2 for more info.
-**Beware that Distutils2 is its in early stage and should not be used in
+**Beware that Distutils2 is in its early stage and should not be used in
production. Its API is subject to changes**
diff --git a/src/distutils2/README b/src/distutils2/README
--- a/src/distutils2/README
+++ b/src/distutils2/README
@@ -1,4 +1,4 @@
-This directory contains the Distutils package.
+This directory contains the Distutils2 package.
There's a full documentation available at:
@@ -8,6 +8,6 @@
http://www.python.org/sigs/distutils-sig/
-WARNING: Distutils2 must remain compatible with 2.4
+WARNING: Distutils2 must remain compatible with Python 2.4
$Id: README 70017 2009-02-27 12:53:34Z tarek.ziade $
diff --git a/src/distutils2/_backport/pkgutil.py b/src/distutils2/_backport/pkgutil.py
--- a/src/distutils2/_backport/pkgutil.py
+++ b/src/distutils2/_backport/pkgutil.py
@@ -809,7 +809,7 @@
returned if one is found that has metadata that matches *name* for the
*name* metadata field.
- This function only returns the first result founded, as no more than one
+ This function only returns the first result found, as no more than one
value is expected. If the directory is not found, ``None`` is returned.
:rtype: :class:`Distribution` or :class:`EggInfoDistribution: or None"""
@@ -867,7 +867,7 @@
then all files and directories ending with ``.egg-info`` are considered
as well and returns an :class:`EggInfoDistribution` instance.
- This function only returns the first result founded, since no more than
+ This function only returns the first result found, since no more than
one values are expected. If the directory is not found, returns ``None``.
:parameter version: a version specifier that indicates the version
diff --git a/src/distutils2/_backport/sysconfig.cfg b/src/distutils2/_backport/sysconfig.cfg
--- a/src/distutils2/_backport/sysconfig.cfg
+++ b/src/distutils2/_backport/sysconfig.cfg
@@ -1,6 +1,6 @@
[globals]
# These are the useful categories that are sometimes referenced at runtime,
-# using pkgutils.open():
+# using pkgutil.open():
config = {confdir}/{distribution.name} # Configuration files
appdata = {datadir}/{distribution.name} # Non-writable data that is independent of architecture (images, many xml/text files)
appdata.arch = {libdir}/{distribution.name} # Non-writable data that is architecture-dependent (some binary data formats)
diff --git a/src/distutils2/metadata.py b/src/distutils2/metadata.py
--- a/src/distutils2/metadata.py
+++ b/src/distutils2/metadata.py
@@ -105,7 +105,6 @@
keys = fields.keys()
possible_versions = ['1.0', '1.1', '1.2']
-
# first let's try to see if a field is not part of one of the version
for key in keys:
if key not in _241_FIELDS and '1.0' in possible_versions:
@@ -128,9 +127,9 @@
raise MetadataConflictError('You used incompatible 1.1 and 1.2 fields')
# we have the choice, either 1.0, or 1.2
- # - 1.0 has a broken Summary field but work with all tools
+ # - 1.0 has a broken Summary field but works with all tools
# - 1.1 is to avoid
- # - 1.2 fixes Summary but is not spreaded yet
+ # - 1.2 fixes Summary but is not widespread yet
if not is_1_1 and not is_1_2:
# we couldn't find any specific marker
if PKG_INFO_PREFERRED_VERSION in possible_versions:
@@ -633,4 +632,3 @@
operations = _CHAIN(execution_context)
tokenize(StringIO(marker).readline, operations.eat)
return operations.result()
-
diff --git a/src/distutils2/tests/test_bdist.py b/src/distutils2/tests/test_bdist.py
--- a/src/distutils2/tests/test_bdist.py
+++ b/src/distutils2/tests/test_bdist.py
@@ -33,9 +33,9 @@
# we should add a registry
formats = ['zip', 'gztar', 'bztar', 'ztar', 'tar', 'wininst', 'msi']
formats.sort()
- founded = cmd.format_command.keys()
- founded.sort()
- self.assertEquals(founded, formats)
+ found = cmd.format_command.keys()
+ found.sort()
+ self.assertEquals(found, formats)
def test_suite():
return unittest.makeSuite(BuildTestCase)
diff --git a/src/distutils2/util.py b/src/distutils2/util.py
--- a/src/distutils2/util.py
+++ b/src/distutils2/util.py
@@ -1,7 +1,6 @@
"""distutils.util
-Miscellaneous utility functions -- anything that doesn't fit into
-one of the other *util.py modules.
+Miscellaneous utility functions.
"""
__revision__ = "$Id: util.py 77761 2010-01-26 22:46:15Z tarek.ziade $"
diff --git a/src/runtests.py b/src/runtests.py
--- a/src/runtests.py
+++ b/src/runtests.py
@@ -1,6 +1,6 @@
"""Tests for distutils2.
-The tests for distutils2 are defined in the distutils2.tests package;
+The tests for distutils2 are defined in the distutils2.tests package.
"""
import sys
diff --git a/src/setup.py b/src/setup.py
--- a/src/setup.py
+++ b/src/setup.py
@@ -90,7 +90,7 @@
packages=find_packages(),
cmdclass={'sdist': sdist_hg, 'install': install_hg},
package_data={'distutils2._backport': ['sysconfig.cfg']},
- project_url=[('Mailing-list',
+ project_url=[('Mailing list',
'http://mail.python.org/mailman/listinfo/distutils-sig/'),
('Documentation',
'http://packages.python.org/Distutils2'),
--
Repository URL: http://hg.python.org/distutils2
More information about the Python-checkins
mailing list