Re: [remote-playback] Fix ReSpec definitions of RemotePlayback interface and other issues. (#151)

> I can try to follow that setup but I would like to understand how it works first; the ReSpec guide doesn't seem to explain how you can have multiple definitions of the same term.

You cannot but there won't be multiple definitions of the same term. ReSpec is smart enough to generate `<a>` and not `<dfn>` in WebIDL blocks when the definitions already appear elsewhere in the spec.

> From the issue it sounded like we shouldn't submit this spec for cross referencing yet because of issues with term definitions like `RemotePlayback`; @tabatkins says you can't define it with a plain `<dfn>`, which is what this PR is trying to resolve.

That's no longer relevant. Shepherd could not crawl the /TR version because it was too old at the time and did not yet follow the definitions data model. Also, since Shepherd does not run JavaScript, it cannot crawl raw (as opposed to generated versions of) ReSpec specs, so our Editor's Draft could not be added either. Since then, the /TR version was updated (and now matches the Editor's Draft) and we've been publishing the generated version of the spec to GitHub Pages in any case. Shepherd can crawl either version without problems.

FYI, there are a minority of specs that don't follow the "definitions in prose" pattern and rather have the definitions in the WebIDL block, or that use a mix of both approaches (for instance, the HTML spec has the interface definitions in the WebIDL blocks but methods definitions in the prose). That's why I suggested that this was up to you ;)

Note I'm happy to volunteer and update the PR to what I think would be the right result if you'd like me to!




-- 
GitHub Notification of comment by tidoust
Please view or discuss this issue at https://github.com/w3c/remote-playback/pull/151#issuecomment-1262578791 using your GitHub account


-- 
Sent via github-notify-ml as configured in https://github.com/w3c/github-notify-ml-config

Received on Thursday, 29 September 2022 17:20:19 UTC