Skip to content

Extract examples Improve example checking and generate example files #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 21, 2018

Conversation

gkellogg
Copy link
Member

This update makes use of improved features in extract-examples.rb to process all files, rather than simply doing syntactic validation, and to compare with expected results. Expected results have @data-result-for referencing the title of the source example. Expected results can also be in script elements, which don't show up in the rendered documentation.

The extract-examples script was also updated to extract JSON, as well as generate Turtle/TriG and YAML for most examples; these are updated using rake examples.

Eventually, multiple formats will be associated with each example, so the identification mechanism may change.

@iherman
Copy link
Member

iherman commented Aug 19, 2018

@gkellogg I do not really have the background for a formal review: I have never looked into the detail of this before. At this stage, from the WG's point of view, this should just be an input to the WG that we will have to formally look into, without any reference to the previous stage (which the WG has never looked into yet anyway). Ie, I would say, just merge it, and then, at some point, the WG will have to look it it overall.

This is also valid for the two other PR-s of a similar vein: w3c/json-ld-syntax#49 and w3c/json-ld-api#23

@gkellogg gkellogg merged commit 74d4a29 into master Aug 21, 2018
@gkellogg gkellogg deleted the extract-examples branch August 21, 2018 00:55
@iherman iherman mentioned this pull request Oct 18, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants