Address #1857: Fix typo/phrasing through AudioWorkletNode #1902

rtoy · 2019-05-17T16:53:46Z

Fix typos and phrasing
Add/adjust some links

* Fix typos and phrasing * Add/adjust some links

rtoy · 2019-05-17T16:54:14Z

There are a few more items that I need to ask about before finishing this PR.

rtoy · 2019-05-17T16:58:37Z

index.bs

@@ -9814,7 +9814,8 @@ This interface has "entries", "forEach", "get", "has", "keys",
 <pre class="idl">
 [Exposed=Window,
 SecureContext,
- Constructor (BaseAudioContext context, DOMString name, optional AudioWorkletNodeOptions options)]
+ Constructor (BaseAudioContext context, DOMString name,
+              optional AudioWorkletNodeOptions options)]


Split line so that the generated html isn't a pretty long line.

rtoy · 2019-05-17T16:59:36Z

index.bs

 		{{AudioNode/channelCount}}.

 	: <dfn>parameterData</dfn>
 	::
 		This is a list of user-defined key-value pairs that are used
-		to initialize {{AudioParam}} values in
+		to initialize {{AudioParam}} objects in


Not sure about this.

rtoy · 2019-05-17T17:02:52Z

index.bs

@@ -10035,16 +10036,16 @@ Constructors</h5>
 	: <dfn>port</dfn>
 	::
 		Every {{AudioWorkletProcessor}} has an associated
-		<code>port</code> which is a {{MessagePort}}. It is connected to the port on the
+		<code>port</code> which is a {{MessagePort}}. It is connected to a port on the
 		corresponding {{AudioWorkletProcessor}} object allowing


This is the port for the AudioWorkletProcessor. Should this say it's connected to the port for associated AudioWorkletNode?

This port is created by MessageChannel. So the association between port1 and port2 are already implied.

Should I undo this change?

the port is more specific. So yes, I think it's fine as-is.

I prefer "the port" because it's more specific.

rtoy · 2019-05-17T17:03:55Z

index.bs


-	7. Let <var>processorPortSerialization</var> be
+	7. Let <var>processorPortSerialization</var> be the result of


Is this right?

rtoy · 2019-05-17T20:57:32Z

I think I filed new issues for the items I was not sure about. This is ready for review.

hoch

Looks good, but this has a conflict with #1875.

hoch · 2019-05-20T16:30:51Z

index.bs

@@ -9560,8 +9560,8 @@ within a special scope named {{AudioWorkletGlobalScope}}.

 Each {{BaseAudioContext}} possesses exactly one
 {{AudioWorklet}}. Scripts imported using this {{AudioWorklet}}
-are run in one or more {{AudioWorkletGlobalScope}} global scopes,
-which are created to process audio associated with that
+are run in one {{AudioWorkletGlobalScope}} global scope,


I think we can remove "global scope" at the end.

hoch · 2019-05-20T16:33:37Z

index.bs

@@ -10035,16 +10036,16 @@ Constructors</h5>
 	: <dfn>port</dfn>
 	::
 		Every {{AudioWorkletProcessor}} has an associated
-		<code>port</code> which is a {{MessagePort}}. It is connected to the port on the
+		<code>port</code> which is a {{MessagePort}}. It is connected to a port on the
 		corresponding {{AudioWorkletProcessor}} object allowing


This port is created by MessageChannel. So the association between port1 and port2 are already implied.

hoch · 2019-05-20T16:34:28Z

index.bs

@@ -10067,7 +10068,7 @@ in the node.
 		* {{[[callable process]]}} is `true`.

 		* The {{AudioWorkletNode}} is [=actively processing=], meaning
-			ANY of the following states are met:
+			ANY of the following conditions are met:


FYI: https://github.com/WebAudio/web-audio-api/pull/1875/files

Yeah, well, I was only reading the current spec, not considering things PRs that might change things. :-)

We can merge this first, and then I can handle the conflict in #1875.

hoch · 2019-05-20T16:35:58Z

index.bs


-	7. Let <var>processorPortSerialization</var> be
+	7. Let <var>processorPortSerialization</var> be the result of


hoch · 2019-05-23T17:29:00Z

index.bs

@@ -9814,7 +9814,8 @@ This interface has "entries", "forEach", "get", "has", "keys",
 <pre class="idl">
 [Exposed=Window,
 SecureContext,
- Constructor (BaseAudioContext context, DOMString name, optional AudioWorkletNodeOptions options)]
+ Constructor (BaseAudioContext context, DOMString name,
+              optional AudioWorkletNodeOptions options)]


hoch · 2019-05-23T17:29:38Z

index.bs

 		{{AudioNode/channelCount}}.

 	: <dfn>parameterData</dfn>
 	::
 		This is a list of user-defined key-value pairs that are used
-		to initialize {{AudioParam}} values in
+		to initialize {{AudioParam}} objects in


hoch · 2019-05-23T17:30:22Z

index.bs

@@ -10035,16 +10036,16 @@ Constructors</h5>
 	: <dfn>port</dfn>
 	::
 		Every {{AudioWorkletProcessor}} has an associated
-		<code>port</code> which is a {{MessagePort}}. It is connected to the port on the
+		<code>port</code> which is a {{MessagePort}}. It is connected to a port on the
 		corresponding {{AudioWorkletProcessor}} object allowing


I prefer "the port" because it's more specific.

hoch · 2019-05-23T17:31:23Z

index.bs

@@ -10067,7 +10068,7 @@ in the node.
 		* {{[[callable process]]}} is `true`.

 		* The {{AudioWorkletNode}} is [=actively processing=], meaning
-			ANY of the following states are met:
+			ANY of the following conditions are met:


We can merge this first, and then I can handle the conflict in #1875.

rtoy

Fixed nits.

rtoy · 2019-05-23T19:30:46Z

index.bs

@@ -10035,16 +10036,16 @@ Constructors</h5>
 	: <dfn>port</dfn>
 	::
 		Every {{AudioWorkletProcessor}} has an associated
-		<code>port</code> which is a {{MessagePort}}. It is connected to the port on the
+		<code>port</code> which is a {{MessagePort}}. It is connected to a port on the
 		corresponding {{AudioWorkletProcessor}} object allowing


Address WebAudio#1857: Fix typo/phrasing through AudioWorkletNode

1fced68

* Fix typos and phrasing * Add/adjust some links

rtoy added the Editorial/Documentation label May 17, 2019

rtoy commented May 17, 2019

View reviewed changes

hoch self-requested a review May 20, 2019 16:30

hoch reviewed May 20, 2019

View reviewed changes

rtoy added 2 commits May 23, 2019 10:16

Merge branch 'master' into 1857-fix-typos-thru-audio-worklet

58ab031

Remove unneeded words per review

df54a30

hoch approved these changes May 23, 2019

View reviewed changes

rtoy added 2 commits May 23, 2019 12:27

Merge branch 'master' into 1857-fix-typos-thru-audio-worklet

74a0900

Fix nits from review

6ccbdc6

rtoy commented May 23, 2019

View reviewed changes

rtoy merged commit e257359 into WebAudio:master May 23, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Address #1857: Fix typo/phrasing through AudioWorkletNode #1902

Address #1857: Fix typo/phrasing through AudioWorkletNode #1902

rtoy commented May 17, 2019 •

edited by pr-preview bot

Loading

rtoy commented May 17, 2019

rtoy May 17, 2019

hoch May 23, 2019

rtoy May 17, 2019

hoch May 23, 2019

hoch May 23, 2019

rtoy May 17, 2019

hoch May 20, 2019

rtoy May 21, 2019

hoch May 23, 2019

hoch May 23, 2019

rtoy May 23, 2019

rtoy May 23, 2019

rtoy May 17, 2019

hoch May 20, 2019 •

edited

Loading

rtoy commented May 17, 2019

hoch left a comment

hoch May 20, 2019

rtoy May 23, 2019

hoch May 20, 2019

hoch May 20, 2019

rtoy May 21, 2019

hoch May 23, 2019

hoch May 20, 2019 •

edited

Loading

hoch May 23, 2019

hoch May 23, 2019

hoch May 23, 2019

hoch May 23, 2019

rtoy left a comment

rtoy May 23, 2019


		7. Let <var>processorPortSerialization</var> be
		7. Let <var>processorPortSerialization</var> be the result of

Address #1857: Fix typo/phrasing through AudioWorkletNode #1902

Address #1857: Fix typo/phrasing through AudioWorkletNode #1902

Conversation

rtoy commented May 17, 2019 • edited by pr-preview bot Loading

rtoy commented May 17, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hoch May 20, 2019 • edited Loading

Choose a reason for hiding this comment

rtoy commented May 17, 2019

hoch left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hoch May 20, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rtoy left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rtoy commented May 17, 2019 •

edited by pr-preview bot

Loading

hoch May 20, 2019 •

edited

Loading

hoch May 20, 2019 •

edited

Loading