summaryrefslogtreecommitdiff
path: root/graph.py
diff options
context:
space:
mode:
authorNicolas Chauvat <nicolas.chauvat@logilab.fr>2008-07-14 20:10:00 +0200
committerNicolas Chauvat <nicolas.chauvat@logilab.fr>2008-07-14 20:10:00 +0200
commit93ae11ba36e2a59e8d85c8dba4b8bde5a28ca206 (patch)
treecd39aed3f925679bc8a19676ce440703dcd0f6c5 /graph.py
parentaab929e273a41a188a244b5d2c8b3e53408172ab (diff)
downloadlogilab-common-93ae11ba36e2a59e8d85c8dba4b8bde5a28ca206.tar.gz
improve doc for better epydoc generation (again).
Diffstat (limited to 'graph.py')
-rw-r--r--graph.py6
1 files changed, 4 insertions, 2 deletions
diff --git a/graph.py b/graph.py
index 3333652..b2f9c04 100644
--- a/graph.py
+++ b/graph.py
@@ -59,8 +59,10 @@ class DotBackend:
def generate(self, outputfile=None, dotfile=None):
"""Generates a graph file.
- :param target: output format ('png', 'ps', etc.). If None,
- the raw dot source will be returned
+ :param outputfile: filename and path [defaults to graphname.png]
+ :param dotfile: filename and path [defaults to graphname.dot]
+
+ :rtype: str
:return: a path to the generated file
"""
if outputfile is not None: