d documentation

Author: actions-user

approvaltests-tests/src/test/java/org/approvaltests/StoryBoardTest.java

@@ -18,9 +18,11 @@ void gameOfLife()
     gameOfLife = new GameOfLife((x, y) -> y == 2 && 1 <= x && x <= 3);
     Approvals.verify(StoryBoard.createSequence(gameOfLife, 3, gameOfLife::advance));
     gameOfLife = new GameOfLife((x, y) -> y == 2 && 1 <= x && x <= 3);
+    // begin-snippet: StoryBoardExample
     Approvals.verify(new StoryBoard().add(gameOfLife).addFrames(3, gameOfLife::advance));
+    // end-snippet
   }
-  private class GameOfLife
+  private static class GameOfLife
   {
     private Function2<Integer, Integer, Boolean> board;
     public GameOfLife(Function2<Integer, Integer, Boolean> board)

approvaltests/docs/Features.md

@@ -29,6 +29,12 @@
     * [Usage](#usage)<!-- endToc -->
 
 ## x.y.z
+
+## 11.7.0
+### StoryBoard
+[see here](reference/StoryBoard.md#top)
+
+## 10.4.0
 ### Configure tests to only run on specific machine
 [see here](how_to/MachineNameSpecificTest.md#top)
 

approvaltests/docs/reference/StoryBoard.md

@@ -0,0 +1,23 @@
+<a id="top"></a>
+
+# StoryBoard
+
+<!-- toc -->
+
+## Contents
+
+* [Paintables](#paintables)
+    * [Why](#why)
+* [How To](#how-to)
+    * [create an animated gif](#create-an-animated-gif)<!-- endToc -->
+
+## How to verify sequences
+
+StoryBoards can be very helpful to tell a story of steps that happen over time.
+Here is a simple example 
+
+snippet: StoryBoardExample
+
+which produces
+
+snippet: StoryBoardTest.gameOfLife.approved.txt

todo.txt

@@ -1,4 +1,6 @@
 
+* Continue to evolve StoryBoard
+
 * Approvals.options.forName.asMachineNameSpecificTest().onlyForEnvironments("Larss-Air.lan", "macbook13").run(this::extracted);
 * better default FrontloadedReporter to handle CI
 + docs for graph for ci consistent