[Python-checkins] r43433 - sandbox/trunk/setuptools/EasyInstall.txt sandbox/trunk/setuptools/setuptools.txt

Thu Mar 30 02:00:11 CEST 2006

Author: phillip.eby
Date: Thu Mar 30 02:00:10 2006
New Revision: 43433
Modified:
 sandbox/trunk/setuptools/EasyInstall.txt
 sandbox/trunk/setuptools/setuptools.txt
Log:
Misc. doc formatting/phrasing corrections
Modified: sandbox/trunk/setuptools/EasyInstall.txt
==============================================================================

--- sandbox/trunk/setuptools/EasyInstall.txt	(original)
+++ sandbox/trunk/setuptools/EasyInstall.txt	Thu Mar 30 02:00:10 2006
@@ -397,7 +397,7 @@
 
 easy_install -f "http://some.example.com/downloads/foo.py#egg=foo-1.0" foo
 
-will install the package as an egg, and 
+will install the package as an egg, and this::
 
 easy_install -zmaxd. \
 -f "http://some.example.com/downloads/foo.py#egg=foo-1.0" foo
Modified: sandbox/trunk/setuptools/setuptools.txt
==============================================================================
--- sandbox/trunk/setuptools/setuptools.txt	(original)
+++ sandbox/trunk/setuptools/setuptools.txt	Thu Mar 30 02:00:10 2006
@@ -362,6 +362,8 @@
 are run, but only downloaded to the project's setup directory if they're
 not already installed locally.
 
+.. _test_loader:
+
 ``test_loader``
 If you would like to use a different way of finding tests to run than what
 setuptools normally uses, you can specify a module name and class name in
@@ -373,9 +375,9 @@
 string in any way it likes, as there are no restrictions on what may be
 contained in a ``test_suite`` string.
 
- The module name and class name must be separated by a ``:``; the default
+ The module name and class name must be separated by a ``:``. The default
 value of this argument is ``"setuptools.command.test:ScanningLoader"``. If
- you want to use the default ``unittest`` behavior instead, you can specify
+ you want to use the default ``unittest`` behavior, you can specify
 ``"unittest:TestLoader"`` as your ``test_loader`` argument instead. This
 will prevent automatic scanning of submodules and subpackages.
 
@@ -568,7 +570,7 @@
 package you depend on is distributed via SourceForge.
 
 If you depend on a package that's distributed as a single ``.py`` file, you
-must include an ``#egg=project-version`` suffix to the URL, to give a project
+must include an ``"#egg=project-version"`` suffix to the URL, to give a project
 name and version number. (Be sure to escape any dashes in the name or version
 by replacing them with underscores.) EasyInstall will recognize this suffix
 and automatically create a trivial ``setup.py`` to wrap the single ``.py`` file
@@ -2153,7 +2155,9 @@
 and the module has an ``additional_tests()`` function, it is called and the
 result (which must be a ``unittest.TestSuite``) is added to the tests to be
 run. If the named suite is a package, any submodules and subpackages are
-recursively added to the overall test suite.
+recursively added to the overall test suite. (Note: if your project specifies
+a ``test_loader``, the rules for processing the chosen ``test_suite`` may
+differ; see the `test_loader`_ documentation for more details.)
 
 Note that many test systems including ``doctest`` support wrapping their
 non-``unittest`` tests in ``TestSuite`` objects. So, if you are using a test
@@ -2411,7 +2415,7 @@
 def find_files_for_foobar(dirname):
 # loop to yield paths that start with `dirname`
 
-And you would register it in a setup script using something like this:
+And you would register it in a setup script using something like this::
 
 entry_points = {
 "setuptools.file_finders": [
