瀏覽代碼

Merge pull request #58442 from novaplusplus/docs-string-humanize-size

Document String's humanize_size static method
Rémi Verschelde 3 年之前
父節點
當前提交
e0d18071a6
共有 1 個文件被更改,包括 2 次插入0 次删除
  1. 2 0
      doc/classes/String.xml

+ 2 - 0
doc/classes/String.xml

@@ -265,6 +265,8 @@
 			<return type="String" />
 			<argument index="0" name="size" type="int" />
 			<description>
+				Converts an integer representing a number of bytes into a human-readable form.
+				Note that this output is in [url=https://en.wikipedia.org/wiki/Binary_prefix#IEC_prefixes]IEC prefix format[/url], and includes [code]B[/code], [code]KiB[/code], [code]MiB[/code], [code]GiB[/code], [code]TiB[/code], [code]PiB[/code], and [code]EiB[/code].
 			</description>
 		</method>
 		<method name="indent" qualifiers="const">