Browse Source

Document how to use logarithm of base 10 with `log()`

(cherry picked from commit 3c4f0ca9c639e11b3a0673b27427538b244533b6)
Hugo Locurcio 2 years ago
parent
commit
9cde5e2977
1 changed files with 2 additions and 2 deletions
  1. 2 2
      modules/gdscript/doc_classes/@GDScript.xml

+ 2 - 2
modules/gdscript/doc_classes/@GDScript.xml

@@ -556,8 +556,8 @@
 			<return type="float" />
 			<return type="float" />
 			<argument index="0" name="s" type="float" />
 			<argument index="0" name="s" type="float" />
 			<description>
 			<description>
-				Natural logarithm. The amount of time needed to reach a certain level of continuous growth.
-				[b]Note:[/b] This is not the same as the "log" function on most calculators, which uses a base 10 logarithm.
+				Returns the [url=https://en.wikipedia.org/wiki/Natural_logarithm]natural logarithm[/url] of [code]s[/code] (base [url=https://en.wikipedia.org/wiki/E_(mathematical_constant)][i]e[/i][/url], with [i]e[/i] being approximately 2.71828). This is the amount of time needed to reach a certain level of continuous growth.
+				[b]Note:[/b] This is not the same as the "log" function on most calculators, which uses a base 10 logarithm. To use base 10 logarithm, use [code]log(x) / log(10)[/code].
 				[codeblock]
 				[codeblock]
 				log(10) # Returns 2.302585
 				log(10) # Returns 2.302585
 				[/codeblock]
 				[/codeblock]