summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2023-03-24 21:10:43 +0100
committerYuri Sizov <yuris@humnom.net>2023-03-27 17:57:14 +0200
commitb85cead4b9edb2fe15af9515958ecf02db0cac39 (patch)
tree826cbe4665275e26258722c7b8a54468c7702d4b /doc/classes
parent38595b8470128604c40028b076e9be695c847299 (diff)
Document how to use logarithm of base 10 with `log()`
(cherry picked from commit 3c4f0ca9c639e11b3a0673b27427538b244533b6)
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/@GlobalScope.xml4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml
index 9600ad4382..8db668af0a 100644
--- a/doc/classes/@GlobalScope.xml
+++ b/doc/classes/@GlobalScope.xml
@@ -645,8 +645,8 @@
<return type="float" />
<param index="0" name="x" type="float" />
<description>
- Returns the natural logarithm of [param x]. 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.
+ Returns the [url=https://en.wikipedia.org/wiki/Natural_logarithm]natural logarithm[/url] of [param x] (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]
log(10) # Returns 2.302585
[/codeblock]