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

Do some editorial adjustments to the Sensor algorithms. #425

Merged
merged 1 commit into from
Dec 14, 2021

Conversation

rakuco
Copy link
Member

@rakuco rakuco commented Dec 13, 2021

  • Use Web IDL's definition conventions for methods and
    getters (Define definition conventions whatwg/webidl#882):

    • Describe getters as "The attr getter steps are [...]".
    • Describe methods as "The myMethod(arg) method steps are [...]".
  • Refer to [=this=] as defined in Web IDL rather than a concept that was not
    defined anywhere.

  • Use [=this=] rather than the sensor_instance variable where possible, as
    the latter was not defined anywhere.

  • When invoking the "notify error" abstract operation, pass the arguments in
    the order expected by the operation.


Preview | Diff

- Use Web IDL's definition conventions for methods and
  getters (whatwg/webidl#882):
  - Describe getters as "The attr getter steps are [...]".
  - Describe methods as "The myMethod(arg) method steps are [...]".

- Refer to [=this=] as defined in Web IDL rather than a concept that was not
  defined anywhere.

- Use [=this=] rather than the `sensor_instance` variable where possible, as
  the latter was not defined anywhere.

- When invoking the "notify error" abstract operation, pass the arguments in
  the order expected by the operation.
Gets the {{DOMException}} object passed to {{SensorErrorEventInit}}.
The {{SensorErrorEvent/error!!attribute}} getter steps are to return the value it was initialized to.

It represents the {{DOMException}} object passed to {{SensorErrorEventInit}}.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As a follow-up we should really properly specify the constructor algorithm and internal slots for SensorErrorEvent instead of this hand-wavy description.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, I opened an issue for that: #426

Gets the {{DOMException}} object passed to {{SensorErrorEventInit}}.
The {{SensorErrorEvent/error!!attribute}} getter steps are to return the value it was initialized to.

It represents the {{DOMException}} object passed to {{SensorErrorEventInit}}.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, I opened an issue for that: #426

@anssiko
Copy link
Member

anssiko commented Dec 14, 2021

@rakuco, thanks for this PR, I'll merge this now and we can handle any follow-ups later.

@anssiko anssiko merged commit f9caadf into w3c:main Dec 14, 2021
github-actions bot added a commit that referenced this pull request Dec 14, 2021
SHA: f9caadf
Reason: push, by @anssiko

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@rakuco rakuco deleted the algorithm-proof-reading branch December 14, 2021 10:46
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

Successfully merging this pull request may close these issues.

3 participants