Skip to content

Remove inaccurate documentation about __tag__ in JSON specs - #120

Closed
softmoth wants to merge 2 commits into
mustache:masterfrom
softmoth:readme-yaml-notag
Closed

Remove inaccurate documentation about __tag__ in JSON specs#120
softmoth wants to merge 2 commits into
mustache:masterfrom
softmoth:readme-yaml-notag

Conversation

@softmoth

Copy link
Copy Markdown
Contributor

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.

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 jgonggrijp left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@softmoth

Copy link
Copy Markdown
Contributor Author

I see. The __tag__ got removed after #113 was merged (commit 9944f2). I will look into how to put it back.

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!

@softmoth softmoth closed this Mar 19, 2021
@softmoth

Copy link
Copy Markdown
Contributor Author

BTW, the Rakefile hasn't inserted __tag__ since Ruby 1.9.3 switched the YAML processor from Syck to Psych. It's possibly why the JSON files hadn't been updated since 2011.

@jgonggrijp

Copy link
Copy Markdown
Member

@softmoth You are right that the current numbering layout is broken. I didn't realize that.

@softmoth
softmoth deleted the readme-yaml-notag branch March 20, 2021 06:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants