diff options
| -rw-r--r-- | saga.pdf | bin | 143923 -> 145520 bytes | |||
| -rw-r--r-- | saga.yarn | 16 |
2 files changed, 10 insertions, 6 deletions
| Binary files differ @@ -121,12 +121,16 @@ concatenated with the **cat**(1) utility. Within the logical file, normal Markdown and Pandoc markup can be used to structure the document in any way that aids human understanding of the acceptance test suite, which the caveat that chapter or section headings are used -by Saga to group code blocks into scenarios. All code blocks for the -same scenario MUST be under the same heading, and there can be no -sub-headings inside the scenario. It doesn't matter if the heading is -chapter, section, subsection, or deeper, and different scenario -headings can be at different levels, as long as each scenario has no -subdivisions. +by Saga to group code blocks into scenarios. + +All code blocks for the same scenario MUST be grouped under a single +heading. Sub-headings are permitted within a scenario, but the next +heading at the same or a higher level will end the scenario. This +allows for scenarios to begin at any level, but not to leak into a +wider scope within the acceptance document. For example, a scenario +which starts after a level 2 heading may have subdivisions marked with +level 3 or below headings, but will end at the next level 2 or level 1 +heading. FIXME: Discuss whether it would be useful for Saga to support, say, PlantUML and Graphviz code blocks for graphs and stuff. |