summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRichard Maw <richard.maw@gmail.com>2021-07-12 22:20:49 +0100
committerRichard Maw <richard.maw@gmail.com>2021-07-12 22:20:49 +0100
commit1b631528da5bcc5144def58b8c71d3817b7d148b (patch)
tree23c23f5fff335040227b2cc6db4c63a2991f4804
parent6ed60f68f669b2997a1befd1a5b739aded3ae709 (diff)
downloadsubplot-1b631528da5bcc5144def58b8c71d3817b7d148b.tar.gz
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.
-rw-r--r--subplot.md4
1 files 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)`