Remove inaccurate documentation about __tag__ in JSON specs - #120
Remove inaccurate documentation about __tag__ in JSON specs#120softmoth wants to merge 2 commits into
Conversation
There is no special `__tag__` key in the JSON files. Instead, it is the `lambda` entry which is significant. While Ruby may depend on the YAML `!code` tag, that doesn't make it into the JSON format.
jgonggrijp
left a comment
There was a problem hiding this comment.
I'm not opposed to using backticks instead of quotes, but I don't think that the removal of the nesting in the TESTING.md is an improvement. Those steps are actually substeps of the top-level step 2.
More importantly, historically it is not true that the __tag__ isn't there. On latest master it seems to have disappeared, but it was still there in the 1.1.3 tag. I would rather consider this a regression and fix it than changing the README because of it.
|
I see. The The nesting isn't valid Markdown, and breaks the display when viewing the rendered file, as on Github. Please compare:
I will moving what was "item" 2.1 back under item 2 as a mock sub-heading to see if it is better. Unfortunately, Markdown doesn't handle this particular structure elegantly as far as I know. I'll open a separate issue just for fixing this display issue. Thanks for your review! |
|
BTW, the Rakefile hasn't inserted |
|
@softmoth You are right that the current numbering layout is broken. I didn't realize that. |
There is no special
__tag__key in the JSON files. Instead, itis the
lambdaentry which is significant. While Ruby may dependon the YAML
!codetag, that doesn't make it into the JSON format.