Skip to content

Commit

Permalink
document that clean=True only deletes intermediate files on successfu…
Browse files Browse the repository at this point in the history
…l rendering

- close #136  (supersedes #137)
  • Loading branch information
xflr6 committed Jul 13, 2021
1 parent e4cca42 commit 6e9774b
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions graphviz/files.py
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ def render(self, filename=None, directory=None, view=False, cleanup=False,
filename: Filename for saving the source (defaults to ``name`` + ``'.gv'``)
directory: (Sub)directory for source saving and rendering.
view (bool): Open the rendered result with the default application.
cleanup (bool): Delete the source file after rendering.
cleanup (bool): Delete the source file after successful rendering.
format: The output format used for rendering (``'pdf'``, ``'png'``, etc.).
renderer: The output renderer used for rendering (``'cairo'``, ``'gd'``, ...).
formatter: The output formatter used for rendering (``'cairo'``, ``'gd'``, ...).
Expand Down Expand Up @@ -255,7 +255,7 @@ def view(self, filename=None, directory=None, cleanup=False,
Args:
filename: Filename for saving the source (defaults to ``name`` + ``'.gv'``)
directory: (Sub)directory for source saving and rendering.
cleanup (bool): Delete the source file after rendering.
cleanup (bool): Delete the source file after successful rendering.
quiet (bool): Suppress ``stderr`` output from the layout subprocess.
quiet_view (bool): Suppress ``stderr`` output from the viewer process
(ineffective on Windows).
Expand Down

0 comments on commit 6e9774b

Please sign in to comment.