summaryrefslogtreecommitdiff
path: root/subplot.md
diff options
context:
space:
mode:
authorDaniel Silverstone <dsilvers+gitlab@digital-scurf.org>2022-04-26 11:07:50 +0000
committerDaniel Silverstone <dsilvers+gitlab@digital-scurf.org>2022-04-26 11:07:50 +0000
commit12059fcb1ce8237e5587773043cd442e036531c2 (patch)
tree8940d4eca8c663e72cf051b22b9232eb6a84b056 /subplot.md
parent924e05bc3d109340eeee7e06c6badeae12d45c10 (diff)
parent3422999e5a4fc6b08637d00cae11f523c747f036 (diff)
downloadsubplot-12059fcb1ce8237e5587773043cd442e036531c2.tar.gz
Merge branch 'liw/diagram' into 'main'
refactor: use "diagram" instead of "graph" Closes #255 See merge request subplot/subplot!273
Diffstat (limited to 'subplot.md')
-rw-r--r--subplot.md24
1 files changed, 12 insertions, 12 deletions
diff --git a/subplot.md b/subplot.md
index 18fe8d5..3d4fb91 100644
--- a/subplot.md
+++ b/subplot.md
@@ -87,7 +87,7 @@ Subplot also generates a test program, in Python, that verifies the
acceptance criteria are met, for developers and testers and auditors
to verify the system under test meets its acceptance criteria. The
generated program uses code written by the Subplot user to implement
-the verification steps. The graph below illustrates this and shows how
+the verification steps. The diagram below illustrates this and shows how
data flows through the system.
```dot
@@ -588,7 +588,7 @@ syntax highlighting, if the language is specified: `.markdown`,
Subplot also understands the `dot` and `roadmap` tags, and can use the
Graphviz dot program, or the [roadmap][] Rust crate, to produce
-graphs. These can useful for describing things visually.
+diagrams. These can useful for describing things visually.
When typesetting files, Subplot will automatically number the lines in
the file so that documentation prose can refer to sections of embedded
@@ -2922,9 +2922,9 @@ title: Two embedded files
~~~~~~
-## Embedded graphs
+## Embedded diagrams
-Subplot allows embedding markup to generate graphs into the Markdown document.
+Subplot allows embedding markup to generate diagrams into the Markdown document.
### Pikchr
@@ -2942,7 +2942,7 @@ arrow <-> down 70% from last box.s
box same "Pikchr" "Formatter" "(docs.rs/pikchr)" fit
~~~
-The scenario checks that a graph is generated and embedded into the HTML output,
+The scenario checks that a diagram is generated and embedded into the HTML output,
and is not referenced as an external image.
~~~scenario
@@ -2972,7 +2972,7 @@ box same "Pikchr" "Formatter" "(docs.rs/pikchr)" fit
[Graphviz]: http://www.graphviz.org/
Dot is a program from the [Graphviz][] suite to generate directed
-graphs, such as this one.
+diagrams, such as this one.
~~~dot
digraph "example" {
@@ -2980,7 +2980,7 @@ thing -> other
}
~~~
-The scenario checks that a graph is generated and embedded into the
+The scenario checks that a diagram is generated and embedded into the
HTML output, not referenced as an external image.
~~~scenario
@@ -2994,7 +2994,7 @@ then file dot.html matches regex /img src="data:image/svg\+xml;base64,/
The sample input file **dot.md**:
~~~~~~~~{#dot.md .file .markdown .numberLines}
-This is an example Markdown file, which embeds a graph using dot markup.
+This is an example Markdown file, which embeds a diagram using dot markup.
~~~dot
digraph "example" {
@@ -3009,7 +3009,7 @@ thing -> other
[PlantUML]: https://plantuml.com/
-[PlantUML][] is a program to generate various kinds of graphs for
+[PlantUML][] is a program to generate various kinds of diagrams for
describing software, such as this one:
~~~plantuml
@@ -3022,7 +3022,7 @@ Alice <-- Bob: Another authentication Response
@enduml
~~~
-The scenario below checks that a graph is generated and embedded into
+The scenario below checks that a diagram is generated and embedded into
the HTML output, not referenced as an external image.
~~~scenario
@@ -3036,7 +3036,7 @@ then file plantuml.html matches regex /img src="data:image/svg\+xml;base64,/
The sample input file **plantuml.md**:
~~~~~~~~{#plantuml.md .file .markdown .numberLines}
-This is an example Markdown file, which embeds a graph using
+This is an example Markdown file, which embeds a diagram using
PlantUML markup.
~~~plantuml
@@ -3103,7 +3103,7 @@ blocked:
- next
~~~
-This scenario checks that a graph is generated and embedded into the
+This scenario checks that a diagram is generated and embedded into the
HTML output, not referenced as an external image.
~~~scenario