summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Siegel <siegeltr@gmail.com>2021-03-20 02:06:10 -0400
committerTim Siegel <siegeltr@gmail.com>2021-03-21 00:26:40 -0400
commit9869f085c78b62afb1aa0c9d882c87cc1dc1aaa9 (patch)
tree5c3eb0726b36e762b4c2e238d4cc0fdb6fc5b1b2
parent989a21a48ba62e8ee54bda6a692f678b8619467a (diff)
downloadmustache-spec-9869f085c78b62afb1aa0c9d882c87cc1dc1aaa9.tar.gz
Fix TESTING.md Markdown list syntax; no content changes
The present indentation isn't valid Markdown, and breaks the display when viewing the rendered file, as on Github. Please compare: - Old: https://github.com/mustache/spec/blob/f75ffbf0a90e6ccecb11df58cdb4cc400ac2919d/TESTING.md - Numbering goes 1, 2, 3 (wrong), 4 (wrong), 2.1 (out-dented, not part of the list), 3, 4. - Bulleted list under section 2.1 is entirely preformatted, rather than rendered as the intended list items - New: https://github.com/softmoth/mustache-spec/blob/format-testing-doc/TESTING.md This patch moves what was "item" 2.1 back under item 2 without an extra list item. Unfortunately, Markdown doesn't handle this particular structure elegantly as far as I know. It also switches to backtick quotes for all literals.
-rw-r--r--TESTING.md51
1 files changed, 25 insertions, 26 deletions
diff --git a/TESTING.md b/TESTING.md
index d2ca374..0befd53 100644
--- a/TESTING.md
+++ b/TESTING.md
@@ -6,41 +6,40 @@ In general, the process for each `.yml` file is as follows:
1. Use a YAML parser to load the file.
-2. For each test in the 'tests' array:
+2. For each test in the `tests` array:
- 1. Ensure that each element of the 'partials' hash (if it exists) is
- stored in a place where the interpreter will look for it.
+ 1. Ensure that each element of the `partials` hash (if it exists) is
+ stored in a place where the interpreter will look for it.
- 2. If your implementation will not support lambdas, feel free to skip over
- the optional '~lambdas.yml' file.
+ 2. If your implementation will not support lambdas, feel free to skip
+ over the optional `~lambdas.yml` file.
- 2.1. If your implementation will support lambdas, ensure that each member of
- 'data' tagged with '!code' is properly processed into a language-
- specific lambda reference.
+ Otherwise, ensure that each member of `data` tagged with `!code` is
+ properly processed into a language-specific lambda reference.
- * e.g. Given this YAML data hash:
+ * e.g. Given this YAML data hash:
- `{ x: !code { ruby: 'proc { "x" }', perl: 'sub { "x" }' } }`
+ `{ x: !code { ruby: 'proc { "x" }', perl: 'sub { "x" }' } }`
- a Ruby-based Mustache implementation would process it such that it
- was equivalent to this Ruby hash:
+ a Ruby-based Mustache implementation would process it such that it
+ was equivalent to this Ruby hash:
- `{ 'x' => proc { "x" } }`
+ `{ 'x' => proc { "x" } }`
- * If your implementation language does not currently have lambda
- examples in the spec, feel free to implement them and send a pull
- request.
+ * If your implementation language does not currently have lambda
+ examples in the spec, feel free to implement them and send a pull
+ request.
- * The JSON version of the spec represents these tagged values as a hash
- with a '`__tag__`' key of 'code'.
+ * The JSON version of the spec represents these tagged values as a
+ hash with a `__tag__` key of `code`.
- 3. Render the template (stored in the 'template' key) with the given 'data'
- hash.
+ 3. Render the template (stored in the `template` key) with the given
+ `data` hash.
- 4. Compare the results of your rendering against the 'expected' value; any
- differences should be reported, along with any useful debugging
- information.
+ 4. Compare the results of your rendering against the `expected` value;
+ any differences should be reported, along with any useful debugging
+ information.
- * Of note, the 'desc' key contains a rough one-line description of the
- behavior being tested -- this is most useful in conjunction with the
- file name and test 'name'.
+ * Of note, the `desc` key contains a rough one-line description of
+ the behavior being tested – this is most useful in conjunction with
+ the file name and test `name`.