summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2024-02-29 13:54:31 +0100
committerRémi Verschelde <rverschelde@gmail.com>2024-02-29 13:54:31 +0100
commitcc21871c9abea359f4d60c5d80f02868ff7c1751 (patch)
treeb58033ab1276f848261dbd603047954627efa4e8
parentd9296e5fddd485b179f98861dc94a7938b7a4bdf (diff)
parent4a1397b58cf3cbdddf657efc575c6066860daf6d (diff)
downloadredot-engine-cc21871c9abea359f4d60c5d80f02868ff7c1751.tar.gz
Merge pull request #88956 from akien-mga/doc-rtl-zero-idx
RTL: Clarify that line, paragraph, and character numbers are zero-indexed
-rw-r--r--doc/classes/RichTextLabel.xml4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml
index 36b990b46b..b294b37b8f 100644
--- a/doc/classes/RichTextLabel.xml
+++ b/doc/classes/RichTextLabel.xml
@@ -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>