Clarify to_float() and to_int() methods

(cherry picked from commit 7bb682651f)
This commit is contained in:
kobewi 2022-01-16 02:11:30 +01:00 committed by Rémi Verschelde
parent 7eb8339f6c
commit ccb52db232
No known key found for this signature in database
GPG key ID: C3336907360768E1

View file

@ -775,13 +775,24 @@
<method name="to_float">
<return type="float" />
<description>
Converts a string containing a decimal number into a [code]float[/code].
Converts a string containing a decimal number into a [code]float[/code]. The method will stop on the first non-number character except the first [code].[/code] (decimal point), and [code]e[/code] which is used for exponential.
[codeblock]
print("12.3".to_float()) # 12.3
print("1.2.3".to_float()) # 1.2
print("12ab3".to_float()) # 12
print("1e3".to_float()) # 1000
[/codeblock]
</description>
</method>
<method name="to_int">
<return type="int" />
<description>
Converts a string containing an integer number into an [code]int[/code].
Converts a string containing an integer number into an [code]int[/code]. The method will remove any non-number character and stop if it encounters a [code].[/code].
[codeblock]
print("123".to_int()) # 123
print("a1b2c3".to_int()) # 123
print("1.2.3".to_int()) # 1
[/codeblock]
</description>
</method>
<method name="to_lower">