Update trollsched/graph.py

Co-authored-by: Martin Raspaud <[email protected]>
pytroll · Dec 4, 2024 · bdc004c · bdc004c
1 parent 754c607
commit bdc004c
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/trollsched/graph.py b/trollsched/graph.py
@@ -131,7 +131,12 @@ def load(self, filename):
         self.vertices = np.arange(self.order)
 
     def export(self, filename="./sched.gv", labels=None):
-        """Dot sched.gv -Tpdf -otruc.pdf."""
+        """Export the schedule to gv format for visualization.
+        
+        To generate a pdf out of it::
+            
+            dot sched.gv -Tpdf -otruc.pdf.
+        """
         with open(filename, "w") as fd_:
             fd_.write('digraph schedule { \n size="80, 10";\n center="1";\n')
             for v1 in range(1, self.order - 1):