From 1b8b380993bf9ee253a72b6da7d7d7cc55868976 Mon Sep 17 00:00:00 2001
From: Aaron Franke <arnfranke@yahoo.com>
Date: Fri, 13 Dec 2019 15:23:26 -0500
Subject: Document that translated does not behave like rotated or scaled

---
 doc/classes/Transform.xml   | 9 +++++----
 doc/classes/Transform2D.xml | 7 ++++---
 2 files changed, 9 insertions(+), 7 deletions(-)

(limited to 'doc')

diff --git a/doc/classes/Transform.xml b/doc/classes/Transform.xml
index 4c4022b3b5..2e447ca1ba 100644
--- a/doc/classes/Transform.xml
+++ b/doc/classes/Transform.xml
@@ -126,7 +126,7 @@
 			<argument index="1" name="phi" type="float">
 			</argument>
 			<description>
-				Rotates the transform around given axis by phi. The axis must be a normalized vector.
+				Rotates the transform around the given axis by the given angle (in radians), using matrix multiplication. The axis must be a normalized vector.
 			</description>
 		</method>
 		<method name="scaled">
@@ -135,16 +135,17 @@
 			<argument index="0" name="scale" type="Vector3">
 			</argument>
 			<description>
-				Scales the transform by the specified 3D scaling factors.
+				Scales the transform by the given scale factor, using matrix multiplication.
 			</description>
 		</method>
 		<method name="translated">
 			<return type="Transform">
 			</return>
-			<argument index="0" name="ofs" type="Vector3">
+			<argument index="0" name="offset" type="Vector3">
 			</argument>
 			<description>
-				Translates the transform by the specified offset.
+				Translates the transform by the given offset, relative to the transform's basis vectors.
+				Unlike [method rotated] and [method scaled], this does not use matrix multiplication.
 			</description>
 		</method>
 		<method name="xform">
diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml
index 6288bb074c..afc8b04dc7 100644
--- a/doc/classes/Transform2D.xml
+++ b/doc/classes/Transform2D.xml
@@ -128,7 +128,7 @@
 			<argument index="0" name="phi" type="float">
 			</argument>
 			<description>
-				Rotates the transform by the given angle (in radians).
+				Rotates the transform by the given angle (in radians), using matrix multiplication.
 			</description>
 		</method>
 		<method name="scaled">
@@ -137,7 +137,7 @@
 			<argument index="0" name="scale" type="Vector2">
 			</argument>
 			<description>
-				Scales the transform by the given factor.
+				Scales the transform by the given scale factor, using matrix multiplication.
 			</description>
 		</method>
 		<method name="translated">
@@ -146,7 +146,8 @@
 			<argument index="0" name="offset" type="Vector2">
 			</argument>
 			<description>
-				Translates the transform by the given offset.
+				Translates the transform by the given offset, relative to the transform's basis vectors.
+				Unlike [method rotated] and [method scaled], this does not use matrix multiplication.
 			</description>
 		</method>
 		<method name="xform">
-- 
cgit v1.2.3