Editorial: quick fixes re Math functions #2174
Conversation
spec.html
Outdated
| </emu-alg> | ||
| <p>The *"length"* property of the `hypot` method is 2.</p> |
There was a problem hiding this comment.
i'm not convinced on this approach; i strongly prefer to minimize the occurrence of explicit length notes.
There was a problem hiding this comment.
The only way to eliminate these three explicit length statements would be for each function to have a heading with exactly 2 "normal" parameters, which would be mislead (or confuse) the reader: it would suggest that:
- a 'proper' call to the function requires at least 2 arguments, or
- if a call supplies less than 2 args, the 'missing' args would be
*undefined*.
But neither is correct for these functions.
Personally, I think it's more important to clearly convey the function's semantics. If that results in the need for an explicit length statement, that doesn't bother me.
In fact, I think it's better to have an explicit length statement in these cases, because it underlines that the length doesn't 'match' the semantics.
There was a problem hiding this comment.
@jmdyck's reasoning is compelling here.
If nothing else, the current rendering is very confusing because "required parameter" within the spec has a very narrow definition, which is "rendered not as a rest parameter and not between [ ]". It so happens that that narrow definition mostly aligns with the broader and more common understanding of "required" that means "needed for the function to do the useful thing". The functions for which these definitions don't align are these Math functions, and so the explicit "length" notes are definitely editorially warranted IMO.
spec.html
Outdated
| @@ -27931,17 +27930,16 @@ <h1>Math.max ( _value1_, _value2_, ..._values_ )</h1> | |||
| <emu-note> | |||
| <p>The comparison of values to determine the largest value is done using the Abstract Relational Comparison algorithm except that *+0* is considered to be larger than *-0*.</p> | |||
| </emu-note> | |||
| <p>The *"length"* property of the `max` method is 2.</p> | |||
| @@ -27950,6 +27948,7 @@ <h1>Math.min ( _value1_, _value2_, ..._values_ )</h1> | |||
| <emu-note> | |||
| <p>The comparison of values to determine the largest value is done using the Abstract Relational Comparison algorithm except that *+0* is considered to be larger than *-0*.</p> | |||
| </emu-note> | |||
| <p>The *"length"* property of the `min` method is 2.</p> | |||
|
force-pushed to:
|
- Math.atan2: Refer to parameters in correct order.
- Math.fround: Call ToNumber on _x_.
Insert "or" into a condition.
- Math.{hypot,max,min}: Accept zero or more arguments.
(max and min have done so since ES3.
hypot has done so since it was introduced in ES6.)
- Math.round: Fix typos: "_x_" -> "_n_"
|
force-pushed to:
|
(Things I missed in my review of PR #2122.)
Brief history of 'max' ('min' is similar):
ES1, ES2:
ES3, ES5:
lengthproperty of themaxmethod is 2.Draft 23 of ES6 deleted the full-bracketing in the heading, unclear why...
ES6:
lengthproperty of themaxmethod is 2.PR #266 removed the line about the
lengthproperty...ES7+: