summaryrefslogtreecommitdiff
path: root/src/typeset.rs
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2019-12-01 17:51:17 +0200
committerLars Wirzenius <liw@liw.fi>2019-12-01 17:51:17 +0200
commit589274d515c432beff64f3deccca12dd3b8cfcf3 (patch)
tree9f8631e5bceda653c9b116bbfcb7c5c4ead88d53 /src/typeset.rs
parentdcdcf6ecc27fd79ac7a95377c8a7e862ae8e1d3a (diff)
downloadsubplot-589274d515c432beff64f3deccca12dd3b8cfcf3.tar.gz
Add: clarify what typesetting means
Diffstat (limited to 'src/typeset.rs')
-rw-r--r--src/typeset.rs4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/typeset.rs b/src/typeset.rs
index b2a0758..cf7ea72 100644
--- a/src/typeset.rs
+++ b/src/typeset.rs
@@ -20,6 +20,10 @@ pub fn error_msg(msg: &str) -> Vec<Inline> {
/// Typeset a scenario snippet as a Pandoc AST Block.
///
+/// Typesetting here means producing the Pandoc abstract syntax tree
+/// nodes that result in the desired output, when Pandoc processes
+/// them.
+///
/// The snippet is given as a text string, which is parsed. It need
/// not be a complete scenario, but it should consist of complete steps.
pub fn scenario_snippet(bindings: &Bindings, snippet: &str) -> Block {