Update JS Array syntax sections to avoid BNF syntaxes #4136
Conversation
files/en-us/web/javascript/reference/global_objects/array/concat/index.html
Outdated
Show resolved
Hide resolved
files/en-us/web/javascript/reference/global_objects/array/concat/index.html
Outdated
Show resolved
Hide resolved
files/en-us/web/javascript/reference/global_objects/array/concat/index.html
Outdated
Show resolved
Hide resolved
files/en-us/web/javascript/reference/global_objects/array/of/index.html
Outdated
Show resolved
Hide resolved
files/en-us/web/javascript/reference/global_objects/array/push/index.html
Outdated
Show resolved
Hide resolved
files/en-us/web/javascript/reference/global_objects/array/unshift/index.html
Outdated
Show resolved
Hide resolved
That part all works very well. I don’t have any more specific feedback than that. I think it’s a significant improvement in clarity and usability. |
| @@ -14,10 +14,15 @@ | |||
|
|
|||
| <h2 id="Syntax">Syntax</h2> | |||
|
|
|||
| <pre class="brush: js">[<var>element0</var>, <var>element1</var>, ..., <var>elementN</var>] | |||
| <pre class="brush: js"> | |||
| // literal constructor | |||
There was a problem hiding this comment.
FMI, generally I use sentence case for comments. Is there a standard on this?
| <pre | ||
| class="brush: js">const <var>new_array</var> = <var>old_array</var>.concat([<var>value1</var>[, <var>value2</var>[, ...[, <var>valueN</var>]]]])</pre> | ||
| <pre class="brush: js"> | ||
| concat() |
There was a problem hiding this comment.
I guess it is valid, but I do wonder what it would "mean".
| @@ -19,8 +19,22 @@ | |||
|
|
|||
| <h2 id="Syntax">Syntax</h2> | |||
|
|
|||
| <pre | |||
| class="brush: js"><var>arr</var>.every(<var>callback</var>(<var>element</var>[, <var>index</var>[, <var>array</var>]])[, <var>thisArg</var>])</pre> | |||
| <pre class="brush: js"> | |||
There was a problem hiding this comment.
FWIW this works really well.
|
Actually, screw it. Merging. I'd rather ask forgiveness. @Elchi3 Can you update the how to docs to capture the n element case? |
In this PR, I've tried to play through the new guidelines for MDN's syntax sections for the JS
Arraybuilt-in. So, here I:<var>in<pre>See https://developer.mozilla.org/en-US/docs/MDN/Structures/Syntax_sections#constructors_and_methods for the new guidelines and openwebdocs/project#26 and the discussion at #2202.
There are a few methods here that use callbacks and there we lack clear guidelines on what to do but I tried to make these better by demonstrating how to use it with arrow functions, functions, and inline functions. I'm especially looking for review feedback on this aspect.