editorial: Modernize the section covering Navigator.getBattery(). #45
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
reillyeon
approved these changes
Aug 27, 2021
Replace most of the prose with internal slots and reference more terms in the `getBattery()` algorithm. The idea was to adopt more modern spec writing practices and make the text stricter, but make no user-visible changes. This includes preserving some oddities in the spec, such as always returning the same promise in `getBattery()`.
rakuco
force-pushed
the
editorial/modernize-and-be-stricter-with-navigator-extension
branch
from
e8460c4
to
08fad35
Compare
reillyeon
approved these changes
Aug 31, 2021
|
I don't have write access to this repository; could either you or @anssiko merge this one? |
|
(and thanks for reviewing!) |
rakuco
deleted the
editorial/modernize-and-be-stricter-with-navigator-extension
branch
rakuco
added a commit
to rakuco/battery
that referenced
this pull request
Sep 1, 2021
Similar to w3c#45, make the `BatteryManager` section more conformant to modern spec writing practices, while avoiding making user-visible changes as much as possible: - Define a task source for this spec, and switch from "queue a task" to the more specific and recent "queue a global task" algorithm. - Replace a lot of prose with internal slots and algorithms. - Make the interface attributes simply return the values of the internal slots rather than defining logic in their getters. - Define an actual algorithm for updating internal slots and dispatching events. The existing prose just said "the UA must change the attribute and fire an event" without really defining how to reach a `BatteryManager` object in the first place.
rakuco
added a commit
to rakuco/battery
that referenced
this pull request
Sep 1, 2021
Similarly to w3c#45, make the `BatteryManager` section more conformant to modern spec writing practices, while avoiding making user-visible changes as much as possible: - Define a task source for this spec, and switch from "queue a task" to the more specific and recent "queue a global task" algorithm. - Replace a lot of prose with internal slots and algorithms. - Make the interface attributes simply return the values of the internal slots rather than defining logic in their getters. - Define an actual algorithm for updating internal slots and dispatching events. The existing prose just said "the UA must change the attribute and fire an event" without really defining how to reach a `BatteryManager` object in the first place.
rakuco
added a commit
to rakuco/battery
that referenced
this pull request
Sep 1, 2021
Similarly to w3c#45, make the `BatteryManager` section more conformant to modern spec writing practices, while avoiding making user-visible changes as much as possible: - Define a task source for this spec, and switch from "queue a task" to the more specific and recent "queue a global task" algorithm. - Replace a lot of prose with internal slots and algorithms. - Make the interface attributes simply return the values of the internal slots rather than defining logic in their getters. - Define an actual algorithm for updating internal slots and dispatching events. The existing prose just said "the UA must change the attribute and fire an event" without really defining how to reach a `BatteryManager` object in the first place.
rakuco
added a commit
to rakuco/battery
that referenced
this pull request
Sep 2, 2021
Similarly to w3c#45, make the `BatteryManager` section more conformant to modern spec writing practices, while avoiding making user-visible changes as much as possible: - Define a task source for this spec, and switch from "queue a task" to the more specific and recent "queue a global task" algorithm. - Replace a lot of prose with internal slots and algorithms. - Make the interface attributes simply return the values of the internal slots rather than defining logic in their getters. - Define an actual algorithm for updating internal slots and dispatching events. The existing prose just said "the UA must change the attribute and fire an event" without really defining how to reach a `BatteryManager` object in the first place.
marcoscaceres
pushed a commit
that referenced
this pull request
Sep 13, 2021
…ger (#46) * editorial: Modernize and replace prose with algorithms in BatteryManager Similarly to #45, make the `BatteryManager` section more conformant to modern spec writing practices, while avoiding making user-visible changes as much as possible: - Define a task source for this spec, and switch from "queue a task" to the more specific and recent "queue a global task" algorithm. - Replace a lot of prose with internal slots and algorithms. - Make the interface attributes simply return the values of the internal slots rather than defining logic in their getters. - Define an actual algorithm for updating internal slots and dispatching events. The existing prose just said "the UA must change the attribute and fire an event" without really defining how to reach a `BatteryManager` object in the first place. * Use [= =] notation in the update battery status and notify algorithm. * Remove non-normative description of BatteryManager's internal slots. The contents are essentially the same as the normative descriptions in the subsequent section. * Use {{BatteryManager}} to refer to it in the text. Refer to the Web IDL interface rather than the BatteryManager concept. * BatteryManager: Define and reference the event types in the Event Handler table.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Replace most of the prose with internal slots and reference more terms in
the
getBattery()algorithm.The idea was to adopt more modern spec writing practices and make the text
stricter, but make no user-visible changes. This includes preserving some
oddities in the spec, such as always returning the same promise in
getBattery().Preview | Diff