Skip to content

IDL index contains fake IDL constructs #281

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

Closed
tidoust opened this issue Aug 16, 2016 · 3 comments
Closed

IDL index contains fake IDL constructs #281

tidoust opened this issue Aug 16, 2016 · 3 comments

Comments

@tidoust
Copy link
Member

tidoust commented Aug 16, 2016

The Worklets draft contains examples of fake IDL constructs. I would expect the IDL index that appears near the end of the document to only list the IDL constructs that the spec normatively defines (WorkletGlobalScope and Worklet). However, this index, automatically generated by Bikeshed, also includes FakeWorklet, giving the feeling that the spec normatively defines that term as well.

I see that there is a way to turn off IDL processing in Bikeshed, although that's probably not what you want here, since the processing itself is useful for the Examples section. I do not know if there is a way to mark the IDL as "example" or "informative" so that Bikeshed does not include it in the IDL index. @tabatkins, is it doable?

@tabatkins
Copy link
Member

Yeah, the fake stuff just needs to be in a non-normative section - it or an ancestor needs a class of "note", "example", or "non-normative". That's currently only indicated in prose in the spec.

@bfgeek
Copy link
Contributor

bfgeek commented Apr 11, 2017

@tabatkins This is fixed right?

@tabatkins
Copy link
Member

Whoops, yeah.

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