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

Rename "error" to better support external references #1168

Open
jugglinmike opened this issue Dec 4, 2017 · 4 comments
Open

Rename "error" to better support external references #1168

jugglinmike opened this issue Dec 4, 2017 · 4 comments

Comments

@jugglinmike
Copy link
Contributor

The spec includes a definition for the term "error." This is appropriate in the context of the document, but it is too generic for use in other specifications--notably, those that define WebDriver extension commands.

This issue came up in a proposal to define an extension command in the Permissions specification. There, @jyasskin commented:

I'm uncomfortable with WebDriver reserving the term "error" globally.

To be clear: this issue does not interfere with the use case of extension commands. External specifications may reference this document's "error" however they wish. (This is what @jyasskin suggests for the Permissions specification.)

However, that seems like it may become a common enough concern to warrant a change here. As @ato suggested:

Would renaming WebDriver’s error definition to, say, WebDriver error or
something better make WebDriver a better citizen for other specifications to
hook into?

This issue is intended to facilitate discussion about that change. Would the editors be open to a patch which re-named "error" to "WebDriver error"?

@andreastt
Copy link
Member

I’m in favour.

@jyasskin
Copy link
Member

jyasskin commented Dec 8, 2017

I also have no objections to the webdriver spec using "error" locally to refer to this concept. In Bikeshed, you'd represent this with https://tabatkins.github.io/bikeshed/#local-lt, but I don't actually see a way to do it in respec.

@andreastt
Copy link
Member

It would be <dfn data-lt=error>WebDriver error</dfn> in ReSpec.

@jyasskin
Copy link
Member

jyasskin commented Dec 8, 2017

I think data-lt in ReSpec is the same as lt in Bikeshed, and that sets a global name, not just a local one.

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

3 participants