break/REFACT(plot) thme.include_steps --> show_steps

Author: ankostis

CHANGES.rst

@@ -383,7 +383,7 @@ PLOT: Badges, StyleStacks, refact Themes, fix style mis-classifications, don't p
 
 + UPD: dot no plot Steps by default;  use this :ref:`plot-customizations` to re-enable them::
 
-      plottable.plot(plotter=Plotter(include_steps=True))
+      plottable.plot(plotter=Plotter(show_steps=True))
 
 + FEAT: now `operations` are also :term:`plottable`.
 

docs/source/pipelines.rst

@@ -90,7 +90,7 @@ into the plot:
 
 .. graphtik::
 
-    >>> dot = out.plot(theme={"include_steps": True})
+    >>> dot = out.plot(theme={"show_steps": True})
 
 .. tip:
    Read :ref:`plot-customizations` to understand the trick with the :term:`plotter`.

docs/source/plotting.rst

@@ -42,7 +42,7 @@ each one capable to producing diagrams with increasing complexity.
 
 For instance, when a pipeline has just been composed, plotting it will
 come out bare bone, with just the 2 types of nodes (data & operations), their
-dependencies, and (optionally, if :term:`plot theme` ``include_steps`` is true)
+dependencies, and (optionally, if :term:`plot theme` ``show_steps`` is true)
 the sequence of the execution-steps of the :term:`plan`.
 
 .. image:: images/barebone_3ops.svg
@@ -133,13 +133,13 @@ ordered by breadth of the effects (most broadly effecting method at the top):
 3. Pass `theme` or `plotter` arguments when calling :meth:`.Plottable.plot()`::
 
       pipeline.plot(plotter=Plotter(kw_legend=None))
-      pipeline.plot(theme=Theme(include_steps=True)
+      pipeline.plot(theme=Theme(show_steps=True)
 
    You may clone and customize an existing plotter, to preserve any pre-existing
    customizations::
 
       active_plotter = get_active_plotter()
-      pipeline.plot(theme={"include_steps": True})
+      pipeline.plot(theme={"show_steps": True})
 
    ... OR::
 

graphtik/plot.py

@@ -577,7 +577,6 @@ class Theme:
                 "bgcolor": "#cc5500",
                 "color": "white",
                 "URL": "https://graphtik.readthedocs.io/en/latest/arch.html#term-returns-dictionary",
-
             },
         }
     }
@@ -698,7 +697,7 @@ class Theme:
     ## Other
     ##
 
-    include_steps = False
+    show_steps = False
     kw_step = {
         "style": "dotted",  # Note: Step styles are not *remerged*.`
         "color": Ref("steps_color"),
@@ -1119,7 +1118,7 @@ def build_pydot(self, plot_args: PlotArgs) -> pydot.Dot:
 
         ## Draw steps sequence, if it's worth it.
         #
-        if steps and theme.include_steps and len(steps) > 1:
+        if steps and theme.show_steps and len(steps) > 1:
             it1 = iter(steps)
             it2 = iter(steps)
             next(it2)

test/test_plot.py

@@ -254,7 +254,7 @@ def _check_common_end(s1, s2, clip_index):
             assert s1 == s2
 
 
-@active_plotter_plugged(Plotter(include_steps=True))
+@active_plotter_plugged(Plotter(show_steps=True))
 def test_plotters_hierarchy(pipeline: Pipeline, inputs, outputs):
     # Plotting original network, no plan.
     base_dot = str(pipeline.plot(inputs=inputs, outputs=outputs))
@@ -390,9 +390,9 @@ def test_Theme_withset():
     p2 = p.withset()
     assert p is not p2
 
-    p3 = p.withset(include_steps=True)
-    assert p3.include_steps
-    assert not p.include_steps
+    p3 = p.withset(show_steps=True)
+    assert p3.show_steps
+    assert not p.show_steps
 
 
 def test_Plotter_with_styles():
@@ -401,9 +401,9 @@ def test_Plotter_with_styles():
     assert p is not p2
     assert p.default_theme is not p2.default_theme
 
-    p3 = p.with_styles(include_steps=True)
-    assert p3.default_theme.include_steps
-    assert not p.default_theme.include_steps
+    p3 = p.with_styles(show_steps=True)
+    assert p3.default_theme.show_steps
+    assert not p.default_theme.show_steps
 
 
 def test_StylesStack_expansion_ok():