[Python-checkins] distutils2: Fix docstrings in sysconfig (see #9877)
tarek.ziade
python-checkins at python.org
Sun Dec 26 14:21:45 CET 2010
tarek.ziade pushed fbcddbb92b14 to distutils2:
http://hg.python.org/distutils2/rev/fbcddbb92b14
changeset: 839:fbcddbb92b14
user: ?ric Araujo <merwok at netwok.org>
date: Mon Nov 22 02:24:57 2010 +0100
summary:
Fix docstrings in sysconfig (see #9877)
files:
distutils2/_backport/sysconfig.py
diff --git a/distutils2/_backport/sysconfig.py b/distutils2/_backport/sysconfig.py
--- a/distutils2/_backport/sysconfig.py
+++ b/distutils2/_backport/sysconfig.py
@@ -87,7 +87,6 @@
"""In the string `path`, replace tokens like {some.thing} with the corresponding value from the map `local_vars`.
If there is no corresponding value, leave the token unchanged.
-
"""
def _replacer(matchobj):
name = matchobj.group(1)
@@ -267,6 +266,7 @@
def get_makefile_filename():
+ """Return the path of the Makefile."""
if _PYTHON_BUILD:
return os.path.join(_PROJECT_BASE, "Makefile")
return os.path.join(get_path('stdlib'), "config", "Makefile")
@@ -361,7 +361,7 @@
return vars
def get_config_h_filename():
- """Returns the path of pyconfig.h."""
+ """Return the path of pyconfig.h."""
if _PYTHON_BUILD:
if os.name == "nt":
inc_dir = os.path.join(_PROJECT_BASE, "PC")
@@ -372,16 +372,16 @@
return os.path.join(inc_dir, 'pyconfig.h')
def get_scheme_names():
- """Returns a tuple containing the schemes names."""
+ """Return a tuple containing the schemes names."""
return tuple(sorted(_SCHEMES.sections()))
def get_path_names():
- """Returns a tuple containing the paths names."""
+ """Return a tuple containing the paths names."""
# xxx see if we want a static list
return _SCHEMES.options('posix_prefix')
def get_paths(scheme=_get_default_scheme(), vars=None, expand=True):
- """Returns a mapping containing an install scheme.
+ """Return a mapping containing an install scheme.
``scheme`` is the install scheme name. If not provided, it will
return the default scheme for the current platform.
@@ -392,7 +392,7 @@
return dict(_SCHEMES.items(scheme))
def get_path(name, scheme=_get_default_scheme(), vars=None, expand=True):
- """Returns a path corresponding to the scheme.
+ """Return a path corresponding to the scheme.
``scheme`` is the install scheme name.
"""
--
Repository URL: http://hg.python.org/distutils2
More information about the Python-checkins
mailing list