[Python-checkins] distutils2: fixed docstrings
tarek.ziade
python-checkins at python.org
Sun Jun 20 23:04:52 CEST 2010
tarek.ziade pushed 14006e536aff to distutils2:
http://hg.python.org/distutils2/rev/14006e536aff
changeset: 215:14006e536aff
tag: tip
user: Tarek Ziade <tarek at ziade.org>
date: Sun Jun 20 23:02:34 2010 +0200
summary: fixed docstrings
files: src/distutils2/depgraph.py
diff --git a/src/distutils2/depgraph.py b/src/distutils2/depgraph.py
--- a/src/distutils2/depgraph.py
+++ b/src/distutils2/depgraph.py
@@ -31,8 +31,7 @@
self.missing = {}
def add_distribution(self, distribution):
- """
- Add the *distribution* to the graph.
+ """Add the *distribution* to the graph.
:type distribution: :class:`pkgutil.Distribution` or
:class:`pkgutil.EggInfoDistribution`
@@ -42,11 +41,9 @@
self.missing[distribution] = list()
def add_edge(self, x, y, label=None):
- """
- Add an edge from distribution *x* to distribution *y* with the given
+ """Add an edge from distribution *x* to distribution *y* with the given
*label*.
-
:type x: :class:`pkgutil.Distribution` or
:class:`pkgutil.EggInfoDistribution`
:type y: :class:`pkgutil.Distribution` or
@@ -70,8 +67,8 @@
def graph_to_dot(graph, f, skip_disconnected=True):
- """
- Writes a DOT output for the graph to the provided file *f*.
+ """Writes a DOT output for the graph to the provided file *f*.
+
If *skip_disconnected* is set to ``True``, then all distributions
that are not dependent on any other distribution are skipped.
@@ -103,8 +100,7 @@
def generate_graph(dists):
- """
- Generates a dependency graph from the given distributions.
+ """Generates a dependency graph from the given distributions.
:parameter dists: a list of distributions
:type dists: list of :class:`pkgutil.Distribution` and
@@ -158,8 +154,7 @@
def dependent_dists(dists, dist):
- """
- Recursively generate a list of distributions from *dists* that are
+ """Recursively generate a list of distributions from *dists* that are
dependent on *dist*.
:param dists: a list of distributions
--
Repository URL: http://hg.python.org/distutils2
More information about the Python-checkins
mailing list