From d49fc76ab8d2a5f7b315cae13d80b83ceea5cf40 Mon Sep 17 00:00:00 2001 From: Will Vincent Date: Sun, 15 Apr 2018 11:40:31 -0500 Subject: [PATCH] Remove incorrect & potentially confusing references to Euler MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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) --- doc/classes/@GDScript.xml | 3 ++- modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml | 2 +- .../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 b6ec305a73f..6e950e8da94 100644 --- a/doc/classes/@GDScript.xml +++ b/doc/classes/@GDScript.xml @@ -326,7 +326,8 @@ - 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 37d04f6f814..e8bc8d24346 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. - 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. 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 6111e270b12..af66e82346c 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. - 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] - Natural log: [code]2.718282[/code] + Mathematical constant [code]e[/code], the natural log base: [code]2.718282[/code] Square root of two: [code]1.414214[/code]