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

(cherry picked from commit 3c4f0ca9c639e11b3a0673b27427538b244533b6)
This commit is contained in:
Hugo Locurcio 2023-03-24 21:10:43 +01:00 committed by Relintai
parent 14c218d23a
commit 892fcff2e1

View File

@ -556,8 +556,8 @@
<return type="float" />
<argument index="0" name="s" type="float" />
<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]
log(10) # Returns 2.302585
[/codeblock]