Define definition conventions #882
Merged
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
... Helps with #730.
domenic
reviewed
May 11, 2020
There was a problem hiding this comment.
Other places to update:
- "To invoke the toJSON() operation of the Transaction interface, run the following steps:"
- "Thus, prose is required to explain the stringification behavior, such as the following paragraph:" we didn't define a convention here, but maybe we should
domenic
reviewed
May 11, 2020
There was a problem hiding this comment.
I'm a bit unsure about introducing the separate concept of "getter description" vs. "getter steps". Maybe instead a phrasing like
The getter steps of an attribute attr should be introduced using text of the form "The ...", or text of the form "The ..." followed by an inline description.
|
There's still a number of inconsistencies here with regard to whether or not this is explicitly passed in. If someone more familiar with all this could add fixup commits that'd be appreciated or we could leave them as existing issues and file a follow-up. |
|
I gave it a shot; please take a look! |
|
This looks great to me. @EdgarChen and @TimothyGu interested in giving this a final review? |
TimothyGu
reviewed
May 13, 2020
|
Nice cleanups :) |
TimothyGu
reviewed
May 14, 2020
TimothyGu
approved these changes
May 15, 2020
domenic
approved these changes
May 15, 2020
jyasskin
approved these changes
May 15, 2020
domenic
added a commit
to whatwg/streams
that referenced
this pull request
Jul 27, 2020
ricea
pushed a commit
to whatwg/streams
that referenced
this pull request
Jul 28, 2020
yutakahirano
pushed a commit
to yutakahirano/streams
that referenced
this pull request
Jun 3, 2021
rakuco
added a commit
to rakuco/wake-lock
that referenced
this pull request
Nov 5, 2021
Aligns with whatwg/webidl#882: - Describe getters as "The attr getter steps are [...]". - Describe methods as "The myMethod(arg) method steps are [...]".
rakuco
added a commit
to rakuco/battery
that referenced
this pull request
Nov 5, 2021
Aligns with whatwg/webidl#882: - Describe getters as "The attr getter steps are [...]". - Describe methods as "The myMethod(arg) method steps are [...]".
rakuco
added a commit
to w3c/battery
that referenced
this pull request
Nov 5, 2021
…rs. (#49) Aligns with whatwg/webidl#882: - Describe getters as "The attr getter steps are [...]". - Describe methods as "The myMethod(arg) method steps are [...]".
rakuco
added a commit
to w3c/screen-wake-lock
that referenced
this pull request
Dec 7, 2021
…rs. (#330) Aligns with whatwg/webidl#882: - Describe getters as "The attr getter steps are [...]". - Describe methods as "The myMethod(arg) method steps are [...]".
rakuco
added a commit
to rakuco/sensors
that referenced
this pull request
Dec 13, 2021
- 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.
rakuco
added a commit
to rakuco/sensors
that referenced
this pull request
Dec 13, 2021
- 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.
rakuco
added a commit
to rakuco/sensors
that referenced
this pull request
Dec 13, 2021
- 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.
rakuco
added a commit
to rakuco/ambient-light
that referenced
this pull request
May 27, 2022
Aligns with whatwg/webidl#882 and uses the format "The _attr_ getter steps are [...]".
miketaylr
pushed a commit
to miketaylr/ambient-light
that referenced
this pull request
Oct 18, 2022
Aligns with whatwg/webidl#882 and uses the format "The _attr_ getter steps are [...]".
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.
...
Helps with #730.
Preview | Diff