diff options
author | Dan Appel <Dan.appel00@gmail.com> | 2021-03-29 15:10:18 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-03-29 15:10:18 -0700 |
commit | e349314b156b61ec1a2f7d0dab30aaa9fe07ed6a (patch) | |
tree | f5216ea7b305090363ba7743f191463254f16a81 | |
parent | 73a469c59a0cdc9ec652edba4d3dd8a247afaecb (diff) | |
parent | 9869f085c78b62afb1aa0c9d882c87cc1dc1aaa9 (diff) | |
download | mustache-spec-e349314b156b61ec1a2f7d0dab30aaa9fe07ed6a.tar.gz |
Merge pull request #122 from softmoth/format-testing-doc
Fix TESTING.md Markdown list syntax; no content changes
-rw-r--r-- | TESTING.md | 51 |
1 files changed, 25 insertions, 26 deletions
@@ -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`. |