649090 - Function destructuring parameters aren't documented.

Status: RESOLVED FIXED

(Developer Documentation Graveyard :: JavaScript, defect)

Description

[Jim Blandy :jimb]

The developer.mozilla.org documentation for function definitions should document destructuring arguments:

js> function f(a, [b, c], {d, e:f}) { print(uneval([a,b,c,d,f])); }
js> f(1,[2,3],{d:4, e:5, x:9})
[1, 2, 3, 4, 5]
js>

Comment 1

[Jim Blandy :jimb]

Not sure I filed this in the right place; Sheppy, can you fix this if I screwed it up?

Comment 2

[Eric Shepherd [:sheppy]]

You got it right.

Comment 3

[Florian Scholz (Open Web Docs)]

Just as a note for myself: 

The function statement page still needs clean-up and needs to mention destructuring params ( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function) but destructuring in general is documented here https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment. Function example see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment#Pulling_fields_from_objects_passed_as_function_parameter

Comment 4

[Florian Scholz (Open Web Docs)]

Also note bug 1018628 (default values not yet working) when documenting this.

Comment 5

[Florian Scholz (Open Web Docs)]

Mentioned here now https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment#Function_argument_defaults for defaults.

And also https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment#Pulling_fields_from_objects_passed_as_function_parameter

I guess we are good for now. The bug mentioned in comment 4 has dev-doc-needed on it, so it will be re-addressed at some point once this gets actually properly implemented.