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

Syntactically invalid examples push learning curve higher than necessary #118

Closed
filip26 opened this issue Nov 13, 2024 · 3 comments
Closed
Assignees
Labels
during CR This issue will be addressed during Candidate Recommendation editorial This item is editorial in nature. pr exists A Pull Request exists to address this issue.

Comments

@filip26
Copy link

filip26 commented Nov 13, 2024

Examples should be treated in a better way, many of them are syntactically malformed, many of the others have wrong contexts or different, usually minor like comments, issues preventing from just grabbing an example as is and playing. 

I understand that to some examples are just illustrative, unimportant stuff.
To adopters, having examples in a form that is useful is invaluable and might dramatically boost progress with adopting a spec. 

Don't we have test vectors? Yes, but it's a different case, different phase of adoption - need for a compact test case, which is in contrast to examples, to grab and play. 

I'm happy to contribute to that.

(I know, unfortunately this is not the only W3C spec suffering it)

@msporny msporny added editorial This item is editorial in nature. during CR This issue will be addressed during Candidate Recommendation labels Nov 13, 2024
@msporny msporny self-assigned this Nov 13, 2024
@msporny
Copy link
Member

msporny commented Nov 16, 2024

There are a few things we can do in this spec that we've done in others:

  1. We mark comments and ... annotations as "ignore on copy" using some CSS tricks.
  2. We try to make the first few examples syntactically valid.

We just need to do a full pass on the document and try to get it into proper shape, we haven't done that pass yet, but we should.

I'm waiting on PR #116 to land before doing a full pass.

@msporny msporny added the ready for pr This issue is ready to have a pull request created for it. label Nov 16, 2024
@msporny
Copy link
Member

msporny commented Jan 12, 2025

PR #143 has been raised to address this issue. This issue will be closed once PR #143 has been merged.

@msporny msporny added pr exists A Pull Request exists to address this issue. and removed ready for pr This issue is ready to have a pull request created for it. labels Jan 12, 2025
@msporny
Copy link
Member

msporny commented Jan 20, 2025

PR #143 has been merged, closing.

@msporny msporny closed this as completed Jan 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
during CR This issue will be addressed during Candidate Recommendation editorial This item is editorial in nature. pr exists A Pull Request exists to address this issue.
Projects
None yet
Development

No branches or pull requests

2 participants