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

Warn when IDL members don't have a dfn #935

Closed
halindrome opened this issue Sep 21, 2016 · 4 comments
Closed

Warn when IDL members don't have a dfn #935

halindrome opened this issue Sep 21, 2016 · 4 comments

Comments

@halindrome
Copy link
Contributor

(this came up at TPAC lunch)

ReSpec makes it easy to create IDL, but does not encourage authors to ensure there are prose descriptions for all of the various IDL things declared. There should be warnings if, in particular, IDL definitions are not referenced (outside of IDL blocks).

@marcoscaceres
Copy link
Member

Good suggestion.

@halindrome
Copy link
Contributor Author

I mentioned this in the ARIA working group meeting today and they LOVE the idea. One of their big complaints about some specs is that there is no way to tell what the WebIDL really DOES.

@halindrome
Copy link
Contributor Author

Janina mentioned that the W3C I18N groups may also have concerns in this area. Do you have any comments @r12a ?

@r12a
Copy link
Contributor

r12a commented Oct 5, 2016

Summary descriptions of grammars and algorithms are indeed very helpful to i18n folks when doing reviews, since it can be hard to find the time to plough through algorithms to figure out what they mean, and frustrating if it's actually something simple that could have been explained with a very short side text. (cc @aphillips)

@marcoscaceres marcoscaceres changed the title Lint should warn when IDL definitions don't have references Warn when IDL members don't have a dfn Dec 12, 2016
marcoscaceres added a commit that referenced this issue Dec 20, 2016
* develop:
  v7.1.0
  chore(package): update snyk to version 1.22.1 (#995)
  feat(webidl-contiguous): Warn if IDL member lacks dfn (closes #935) (#991)
  chore(override-configuration): reformat code
  chore(include-config): reformat code
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants