search

w3c / at-driver

AT Driver defines a protocol for introspection and remote control of assistive technology software, using a bidirectional communication channel.
https://w3c.github.io/at-driver
Other
31 stars 4 forks source link

Editorial: Correct references to "result type" #37

Closed jugglinmike closed 1 year ago

jugglinmike commented 1 year ago

"Commands" are generally described to include a "result type," but none of the commands defined actually include such a value. They do include a "return type," as defined by WEBIDL. Since WEBIDL's "return type" does not seem particularly relevant and since the terms "result type" and "return type" have similar connotations in this context, this appears to be an editorial oversight.

Update the command definitions to specify a "result type," and update the explanation of the commands' "remote end steps" to return an instance of the "result type."

See also the corresponding change to the WebDriver BiDi proposal: https://github.com/w3c/webdriver-bidi/pull/192

Preview | Diff

jugglinmike commented 1 year ago

I've pushed a "fixup" commit to make the corrected text formally reference the definition of the "result type" so that the rendered document includes appropriate hyperlinks.

jugglinmike commented 1 year ago

Thanks, @s3ththompson!