diff options
| author | Will Vincent | 2018-04-15 11:40:31 -0500 |
|---|---|---|
| committer | Hein-Pieter van Braam | 2018-04-28 22:47:43 +0200 |
| commit | d49fc76ab8d2a5f7b315cae13d80b83ceea5cf40 (patch) | |
| tree | d2e3572d0793e6297e6c263f80d077c89a9eb79d | |
| parent | d89015cfe30a35f8268a88d1e09ccb79570816e7 (diff) | |
| download | godot-d49fc76ab8d2a5f7b315cae13d80b83ceea5cf40.tar.gz godot-d49fc76ab8d2a5f7b315cae13d80b83ceea5cf40.tar.zst godot-d49fc76ab8d2a5f7b315cae13d80b83ceea5cf40.zip | |
Remove incorrect & potentially confusing references to Euler
e is referred to as Euler’s number, so technically the MATH_EXP description in VisualScript doc was not incorrect, though could potentially lead to confusion.
e is different from Euler’s constant however, making the existing GDScript exp & VisualScriptMathConstant descriptions nvalid.
(cherry picked from commit b6b8c7b21564672ad5e2e96eb95b857c73404b44)
| -rw-r--r-- | doc/classes/@GDScript.xml | 3 | ||||
| -rw-r--r-- | modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml | 2 | ||||
| -rw-r--r-- | modules/visual_script/doc_classes/VisualScriptMathConstant.xml | 4 |
3 files changed, 5 insertions, 4 deletions
diff --git a/doc/classes/@GDScript.xml b/doc/classes/@GDScript.xml index b6ec305a7..6e950e8da 100644 --- a/doc/classes/@GDScript.xml +++ b/doc/classes/@GDScript.xml @@ -326,7 +326,8 @@ <argument index="0" name="s" type="float"> </argument> <description> - Raises the Euler's constant [b]e[/b] to the power of [code]s[/code] and returns it. [b]e[/b] has an approximate value of 2.71828. + The natural exponential function. It raises the mathematical constant [b]e[/b] to the power of [code]s[/code] and returns it. + [b]e[/b] has an approximate value of 2.71828. [codeblock] a = exp(2) # approximately 7.39 [/codeblock] diff --git a/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml b/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml index 37d04f6f8..e8bc8d243 100644 --- a/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml +++ b/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml @@ -80,7 +80,7 @@ Return the natural logarithm of the input. Note that this is not the typical base-10 logarithm function calculators use. </constant> <constant name="MATH_EXP" value="20" enum="BuiltinFunc"> - Return [b]e[/b] raised to the power of the input. [b]e[/b] sometimes called "Euler's number" is a mathematical constant whose value is approximately 2.71828. + Return the mathematical constant [b]e[/b] raised to the specified power of the input. [b]e[/b] has an approximate value of 2.71828. </constant> <constant name="MATH_ISNAN" value="21" enum="BuiltinFunc"> Return whether the input is NaN (Not a Number) or not. NaN is usually produced by dividing 0 by 0, though other ways exist. diff --git a/modules/visual_script/doc_classes/VisualScriptMathConstant.xml b/modules/visual_script/doc_classes/VisualScriptMathConstant.xml index 6111e270b..af66e8234 100644 --- a/modules/visual_script/doc_classes/VisualScriptMathConstant.xml +++ b/modules/visual_script/doc_classes/VisualScriptMathConstant.xml @@ -4,7 +4,7 @@ Commonly used mathematical constants. </brief_description> <description> - Provides common math constants, such as Pi or Euler's constant, on an output Data port. + Provides common math constants, such as Pi, on an output Data port. [b]Input Ports:[/b] none [b]Output Ports:[/b] @@ -35,7 +35,7 @@ Tau: [code]6.283185[/code] </constant> <constant name="MATH_CONSTANT_E" value="4" enum="MathConstant"> - Natural log: [code]2.718282[/code] + Mathematical constant [code]e[/code], the natural log base: [code]2.718282[/code] </constant> <constant name="MATH_CONSTANT_SQRT2" value="5" enum="MathConstant"> Square root of two: [code]1.414214[/code] |