浏览代码

Merge pull request #75300 from Calinou/doc-log-log10

Document how to use logarithm of base 10 with `log()`
Yuri Sizov 2 年之前
父节点
当前提交
9b0bee860f
共有 1 个文件被更改,包括 2 次插入2 次删除
  1. 2 2
      doc/classes/@GlobalScope.xml

+ 2 - 2
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]