Skip to content
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

Add a validation guarantee to curated CDDL extracts #1422

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,9 @@ Data curation brings the following guarantees.

### CDDL extracts

The CDDL extracts currently come with no guarantee whatsoever and may be invalid. Tracked in [#1417](https://github.com/w3c/webref/issues/1417).
- All CDDL files pass CDDL analysis by the version of [Strudy](https://github.com/w3c/strudy) referenced in `package.json`. Said differently, all CDDL files can be parsed by the version of [cddlparser](https://github.com/tidoust/cddlparser) referenced by Strudy.

The CDDL extracts are not released in an NPM package for the time being.

## Known consumers

Expand Down
5 changes: 5 additions & 0 deletions ed/cddlpatches/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# CDDL patches

These are patches applied to the CDDL extracts scraped from specs. These patches can break as specs are updated and thus need ongoing maintenance.

For details on how to create and update patches, please see the [Web IDL patches documentation](../idlpatches/README.md)
Loading
Loading