From c54e09a5a304c1578689f5b98cfee41c24d95848 Mon Sep 17 00:00:00 2001
From: Micky <micheledevita2@gmail.com>
Date: Fri, 1 Mar 2024 00:59:28 +0100
Subject: Overhaul some "uncommon" wording in class reference

---
 doc/classes/CodeEdit.xml | 12 +++++-------
 1 file changed, 5 insertions(+), 7 deletions(-)

(limited to 'doc/classes/CodeEdit.xml')

diff --git a/doc/classes/CodeEdit.xml b/doc/classes/CodeEdit.xml
index bc80b86811..7c6f1a51c4 100644
--- a/doc/classes/CodeEdit.xml
+++ b/doc/classes/CodeEdit.xml
@@ -62,9 +62,8 @@
 			<param index="1" name="end_key" type="String" />
 			<param index="2" name="line_only" type="bool" default="false" />
 			<description>
-				Adds a comment delimiter.
-				Both the start and end keys must be symbols. Only the start key has to be unique.
-				[param line_only] denotes if the region should continue until the end of the line or carry over on to the next line. If the end key is blank this is automatically set to [code]true[/code].
+				Adds a comment delimiter from [param start_key] to [param end_key]. Both keys should be symbols, and [param start_key] must not be shared with other delimiters.
+				If [param line_only] is [code]true[/code] or [param end_key] is an empty [String], the region does not carry over to the next line.
 			</description>
 		</method>
 		<method name="add_string_delimiter">
@@ -73,9 +72,8 @@
 			<param index="1" name="end_key" type="String" />
 			<param index="2" name="line_only" type="bool" default="false" />
 			<description>
-				Adds a string delimiter.
-				Both the start and end keys must be symbols. Only the start key has to be unique.
-				[param line_only] denotes if the region should continue until the end of the line or carry over on to the next line. If the end key is blank this is automatically set to [code]true[/code].
+				Defines a string delimiter from [param start_key] to [param end_key]. Both keys should be symbols, and [param start_key] must not be shared with other delimiters.
+				If [param line_only] is [code]true[/code] or [param end_key] is an empty [String], the region does not carry over to the next line.
 			</description>
 		</method>
 		<method name="can_fold_line" qualifiers="const">
@@ -623,7 +621,7 @@
 			The option is local to the location of the code completion query - e.g. a local variable. Subsequent value of location represent options from the outer class, the exact value represent how far they are (in terms of inner classes).
 		</constant>
 		<constant name="LOCATION_PARENT_MASK" value="256" enum="CodeCompletionLocation">
-			The option is from the containing class or a parent class, relative to the location of the code completion query. Perform a bitwise OR with the class depth (e.g. 0 for the local class, 1 for the parent, 2 for the grandparent, etc) to store the depth of an option in the class or a parent class.
+			The option is from the containing class or a parent class, relative to the location of the code completion query. Perform a bitwise OR with the class depth (e.g. [code]0[/code] for the local class, [code]1[/code] for the parent, [code]2[/code] for the grandparent, etc.) to store the depth of an option in the class or a parent class.
 		</constant>
 		<constant name="LOCATION_OTHER_USER_CODE" value="512" enum="CodeCompletionLocation">
 			The option is from user code which is not local and not in a derived class (e.g. Autoload Singletons).
-- 
cgit v1.2.3