RTL: Clarify that line, paragraph, and character numbers are zero-indexed

Closes #82885.
This commit is contained in:
Rémi Verschelde 2024-02-28 13:46:01 +01:00
parent df78c0636d
commit 4a1397b58c
No known key found for this signature in database
GPG key ID: C3336907360768E1

View file

@ -69,7 +69,7 @@
<return type="int" />
<param index="0" name="character" type="int" />
<description>
Returns the line number of the character position provided.
Returns the line number of the character position provided. Line and character numbers are both zero-indexed.
[b]Note:[/b] If [member threaded] is enabled, this method returns a value for the loaded part of the document. Use [method is_ready] or [signal finished] to determine whether document is fully loaded.
</description>
</method>
@ -77,7 +77,7 @@
<return type="int" />
<param index="0" name="character" type="int" />
<description>
Returns the paragraph number of the character position provided.
Returns the paragraph number of the character position provided. Paragraph and character numbers are both zero-indexed.
[b]Note:[/b] If [member threaded] is enabled, this method returns a value for the loaded part of the document. Use [method is_ready] or [signal finished] to determine whether document is fully loaded.
</description>
</method>