[Python-checkins] distutils2: Remove costly shortcut in __init__ and improve the docstring

[tarek.ziade]

tarek.ziade pushed 80d665209636 to distutils2:

http://hg.python.org/distutils2/rev/80d665209636
changeset:   238:80d665209636
user:        ?ric Araujo <merwok at netwok.org>
date:        Sun Jun 27 02:15:52 2010 +0200
summary:     Remove costly shortcut in __init__ and improve the docstring
files:       src/distutils2/__init__.py

diff --git a/src/distutils2/__init__.py b/src/distutils2/__init__.py
--- a/src/distutils2/__init__.py
+++ b/src/distutils2/__init__.py
@@ -1,16 +1,20 @@
 """distutils
 
-The main package for the Python Module Distribution Utilities.  Normally
-used from a setup script as
+The main package for the Python Distribution Utilities 2.  Setup
+scripts should import the setup function from distutils2.core:
 
-   from distutils.core import setup
+    from distutils2.core import setup
 
-   setup (...)
+    setup(name=..., version=..., ...)
+
+Third-party tools can use parts of Distutils2 as building blocks
+without causing the other modules to be imported:
+
+    import distutils2.version
+    import distutils2.pypi.simple
+    import distutils2.tests.pypi_server
 """
-__all__ = ['__version__', 'setup']
+__all__ = ['__version__']
 
 __revision__ = "$Id: __init__.py 78020 2010-02-06 16:37:32Z benjamin.peterson $"
 __version__ = "1.0a2"
-
-from distutils2.core import setup
-

--
Repository URL: http://hg.python.org/distutils2