Improve documentation of mathematical functions #9994
Merged
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.
Adds better documentation to the functions from the
Math
module. Unfortunately, this means the module no longer uses macros to quickly generate thoseLibM
wrappers.Also changes the parameter names of some functions, for consistency with either similar functions or other overloads:
Math.atan2(value1, value2)
=>Math.atan2(y, x)
Math.log(numeric, base)
=>Math.log(value, base)
Math.besselj(value1, value2)
=>Math.besselj(order, value)
, ditto for.bessely
Math.ldexp(value1, value2)
=>Math.ldexp(value, exp)
Math.scalbn(value1, value2)
=>Math.scalbn(value, exp)
Math.exp(z : Complex)
=>Math.exp(value : Complex)
, ditto for theComplex
overloads of.log
,.log2
,.log10
, and.sqrt
This could break code that uses named arguments for these mathematical functions. They are probably very rare though.