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

Fixes for “curated” branch #1091

Closed
SofyaPovarova opened this issue Nov 23, 2023 · 2 comments
Closed

Fixes for “curated” branch #1091

SofyaPovarova opened this issue Nov 23, 2023 · 2 comments

Comments

@SofyaPovarova
Copy link

SofyaPovarova commented Nov 23, 2023

Hi from JetBrains!

We are investigating the possibility of using webref JSONs for automated validation of the CSS property values in JetBrains IDEs. I noticed that several JSONs contain entries without value descriptions and wonder if JSONs in the “curated” branch could be closer to the original specifications and more machine-friendly so that we could use the webref data right away for automated validation.

I’ve created two issues as examples:

  1. Add “value” field to “<dimension-unit>”
  2. Move “<color>” “values” to “<named-color>”

I hope my suggestions make sense and thank you very much for maintaining the webref repository.

@tidoust
Copy link
Member

tidoust commented Nov 23, 2023

Hi @SofyaPovarova. Thanks for reaching out!

The curation process in Webref is really intended to fix (hopefully temporary) inconsistencies that emerge from time to time in the original specifications, for instance situations where the same CSS property is defined in two different specifications. It is not meant to create data that the original specification does not already expose in a machine-readable way.

To improve the quality of the data that appears in Webref, our general approach is not to do more curation in Webref, but rather to improve the specifications themselves, by raising issues or preparing pull requests against them. We try to reduce the amount of manual maintenance that we need to do to keep the data in Webref up-to-date. A side goal is also to improve the quality of the specifications. There may be other ways to achieve the same results.

Said differently, we don't want the data to "be closer to the original specifications", we want the data to be "in the original specifications".

I'll reply to the individual examples that you raised. Both of them are illustrative of improvements that could be brought to the original specifications. If you could help with that, that would be terrific! Things are slightly easier with IDL specifications, as they use Web IDL which is easy to extract. The value definition syntax is used less systematically in CSS specifications, making it harder to extract machine-readable information all the way down to values.

@SofyaPovarova
Copy link
Author

Many thanks for the detailed explanation! I hadn't considered fixing value definitions in specs, but I agree that's the right approach

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

No branches or pull requests

2 participants