Merge pull request #42906 from Xrayez/doc-xref-color-ref-rects

Cross-reference `ColorRect` and `ReferenceRect` in the class reference
godotengine · Oct 22, 2020 · 003ee8b · 003ee8b
2 parents 232e77b + 803b046
commit 003ee8b
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/doc/classes/ColorRect.xml b/doc/classes/ColorRect.xml
@@ -4,7 +4,7 @@
 		Colored rectangle.
 	</brief_description>
 	<description>
-		Displays a colored rectangle.
+		Displays a rectangle filled with a solid [member color]. If you need to display the border alone, consider using [ReferenceRect] instead.
 	</description>
 	<tutorials>
 		<link title="2D Dodge The Creeps Demo">https://godotengine.org/asset-library/asset/515</link>

diff --git a/doc/classes/ReferenceRect.xml b/doc/classes/ReferenceRect.xml
@@ -4,7 +4,7 @@
 		Reference frame for GUI.
 	</brief_description>
 	<description>
-		A rectangle box that displays only a [member border_color] border color around its rectangle. [ReferenceRect] has no fill [Color].
+		A rectangle box that displays only a [member border_color] border color around its rectangle. [ReferenceRect] has no fill [Color]. If you need to display a rectangle filled with a solid color, consider using [ColorRect] instead.
 	</description>
 	<tutorials>
 	</tutorials>