From 1b631528da5bcc5144def58b8c71d3817b7d148b Mon Sep 17 00:00:00 2001 From: Richard Maw Date: Mon, 12 Jul 2021 22:20:49 +0100 Subject: Make it a little more obvious file helpers return contents While reading through the lack of examples left it not obvious whether the embedded file helpers returned a path to a resource or temporary file, or the contents of the file itself. --- subplot.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/subplot.md b/subplot.md index 1ef6ad9..0db6c65 100644 --- a/subplot.md +++ b/subplot.md @@ -756,7 +756,7 @@ accessed using another function: - `cap_get key` -Similarly, there's a dict for embedded data files: +Similarly, there's a dict for the contents of embedded data files: - `files_get filename` @@ -824,7 +824,7 @@ current state of the context, and each capture from a step as a keyword argument. The keyword argument name is the same as the capture name in the pattern in the bindings file. -Embedded files are accessed using a function: +The contents of embedded files are accessed using a function: - `get_file(filename)` -- cgit v1.2.1 From e7484a9e1faf3338b95e00ada16ff6ff909a0a97 Mon Sep 17 00:00:00 2001 From: Richard Maw Date: Mon, 12 Jul 2021 22:22:19 +0100 Subject: Fix typo --- subplot.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/subplot.md b/subplot.md index 0db6c65..2af4898 100644 --- a/subplot.md +++ b/subplot.md @@ -1104,7 +1104,7 @@ then bar was done A binding can define a cleanup function, which gets called at the end of the scenario in reverse order for the successful steps. If a step fails, all the cleanups for the successful steps are still called. We -test this for every language templat we support. +test this for every language template we support. ~~~{#cleanup.yaml .file .yaml .numberLines} - given: foo -- cgit v1.2.1 From 42f70058e48e87169246d9700bee5f1ce49103b6 Mon Sep 17 00:00:00 2001 From: Richard Maw Date: Mon, 12 Jul 2021 22:41:20 +0100 Subject: Fix typo in precond_foo I'm assuming these were meant to be _done rather than _none since later functions use _done and the names are close together. --- subplot.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/subplot.md b/subplot.md index 2af4898..01c3414 100644 --- a/subplot.md +++ b/subplot.md @@ -2007,8 +2007,8 @@ then bar was done ~~~{#f.sh .file .bash .numberLines} precond_foo() { - ctx_set bar_none 0 - ctx_set foobar_none 0 + ctx_set bar_done 0 + ctx_set foobar_done 0 } do_bar() { -- cgit v1.2.1 From 774f0abe63e79e2ad2cf16e6f42c2e7bedca0f4b Mon Sep 17 00:00:00 2001 From: Richard Maw Date: Mon, 12 Jul 2021 22:42:05 +0100 Subject: Fix typo of officially Could've gone either way to official or officially but I guessed probably meant to be officially, since "official stamped" implies separate attributes which would otherwise be comma or and separated while "officially stamped" is a compound attribute. --- subplot.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/subplot.md b/subplot.md index 01c3414..d6a2cb2 100644 --- a/subplot.md +++ b/subplot.md @@ -2043,7 +2043,7 @@ to cater to different use cases: - some people would prefer a `git describe` or similar method for indicating the document revision, so Subplot allows the date to be specified via the command line -* a finished, reviewed, officiall stamped document needs a fixed date +* a finished, reviewed, officially stamped document needs a fixed date - Subplot allows this to be written as the `date` metadata field The rules for what Subplot uses as the date or document revision -- cgit v1.2.1 From 9e7a043c4181b945750e0fd2bfc81dde3cdce41a Mon Sep 17 00:00:00 2001 From: Richard Maw Date: Mon, 12 Jul 2021 22:45:24 +0100 Subject: Fix html typo I'm assuming this was accidental since the intended error is a missing input file. --- subplot.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/subplot.md b/subplot.md index d6a2cb2..238f94b 100644 --- a/subplot.md +++ b/subplot.md @@ -2135,7 +2135,7 @@ missing file. ~~~scenario given file missing-binding.md and an installed subplot -when I try to run subplot docgen missing-binding.md -o foo.htmlh +when I try to run subplot docgen missing-binding.md -o foo.html then command fails and stderr contains ": missing-binding.yaml:" ~~~ -- cgit v1.2.1 From 5b75c9af8a8c0c987f62d2231d6bedb2f4e08fa9 Mon Sep 17 00:00:00 2001 From: Richard Maw Date: Tue, 13 Jul 2021 18:49:54 +0100 Subject: Fix implemented typo --- subplot.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/subplot.md b/subplot.md index 238f94b..6ddc2c7 100644 --- a/subplot.md +++ b/subplot.md @@ -2736,7 +2736,7 @@ Alice <-- Bob: Another authentication Response ### Roadmap Subplot supports visual roadmaps using a YAML based markup language, -implemnted by the [roadmap][] Rust library. The library converts the +implemented by the [roadmap][] Rust library. The library converts the roadmap into dot, and that gets rendered as SVG and embedded in the output document by Subplot. -- cgit v1.2.1