better document None as return value of view()

- fix #106
xflr6 · Sep 11, 2020 · 326063b · 326063b
1 parent 21bf42a
commit 326063b
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/graphviz/backend.py b/graphviz/backend.py
@@ -276,6 +276,10 @@ def view(filepath, quiet=False):
                       (ineffective on Windows).
     Raises:
         RuntimeError: If the current platform is not supported.
+
+    Note:
+        There is no option to wait for the application to close, and no way
+        to retrieve the application's exit status.
     """
     try:
         view_func = getattr(view, PLATFORM)

diff --git a/graphviz/files.py b/graphviz/files.py
@@ -236,6 +236,10 @@ def view(self, filename=None, directory=None, cleanup=False,
             RuntimeError: If opening the viewer is not supported.
 
         Short-cut method for calling :meth:`.render` with ``view=True``.
+
+        Note:
+            There is no option to wait for the application to close, and no way
+            to retrieve the application's exit status.
         """
         return self.render(filename=filename, directory=directory,
                            view=True, cleanup=cleanup,