From 5d81742dc861819c92fe0e0a35e3b673fe9ecf03 Mon Sep 17 00:00:00 2001
From: Hugo Locurcio <hugo.locurcio@hugo.pro>
Date: Sat, 11 Dec 2021 17:38:55 +0100
Subject: [PATCH] Document RigidBody2D/3D and particles' angular velocity units

---
 doc/classes/CPUParticles3D.xml           | 6 +++---
 doc/classes/ParticlesMaterial.xml        | 6 +++---
 doc/classes/PhysicsDirectBodyState2D.xml | 4 ++--
 doc/classes/PhysicsDirectBodyState3D.xml | 4 ++--
 doc/classes/RigidDynamicBody2D.xml       | 4 ++--
 doc/classes/RigidDynamicBody3D.xml       | 4 ++--
 6 files changed, 14 insertions(+), 14 deletions(-)

diff --git a/doc/classes/CPUParticles3D.xml b/doc/classes/CPUParticles3D.xml
index 83728a807be..da9c63c0f72 100644
--- a/doc/classes/CPUParticles3D.xml
+++ b/doc/classes/CPUParticles3D.xml
@@ -96,13 +96,13 @@
 			Minimum angle.
 		</member>
 		<member name="angular_velocity_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
-			Each particle's angular velocity will vary along this [Curve].
+			Each particle's angular velocity (rotation speed) will vary along this [Curve] over its lifetime.
 		</member>
 		<member name="angular_velocity_max" type="float" setter="set_param_max" getter="get_param_max" default="0.0">
-			Maximum angular velocity.
+			Maximum initial angular velocity (rotation speed) applied to each particle in [i]degrees[/i] per second.
 		</member>
 		<member name="angular_velocity_min" type="float" setter="set_param_min" getter="get_param_min" default="0.0">
-			Minimum angular velocity.
+			Minimum initial angular velocity (rotation speed) applied to each particle in [i]degrees[/i] per second.
 		</member>
 		<member name="anim_offset_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
 			Each particle's animation offset will vary along this [Curve].
diff --git a/doc/classes/ParticlesMaterial.xml b/doc/classes/ParticlesMaterial.xml
index ed778af26a2..d2261ed4cc2 100644
--- a/doc/classes/ParticlesMaterial.xml
+++ b/doc/classes/ParticlesMaterial.xml
@@ -83,13 +83,13 @@
 			Minimum angle.
 		</member>
 		<member name="angular_velocity_curve" type="Texture2D" setter="set_param_texture" getter="get_param_texture">
-			Each particle's angular velocity will vary along this [CurveTexture].
+			Each particle's angular velocity (rotation speed) will vary along this [CurveTexture] over its lifetime.
 		</member>
 		<member name="angular_velocity_max" type="float" setter="set_param_max" getter="get_param_max" default="0.0">
-			Maximum angular velocity.
+			Maximum initial angular velocity (rotation speed) applied to each particle in [i]degrees[/i] per second.
 		</member>
 		<member name="angular_velocity_min" type="float" setter="set_param_min" getter="get_param_min" default="0.0">
-			Minimum angular velocity.
+			Minimum initial angular velocity (rotation speed) applied to each particle in [i]degrees[/i] per second.
 		</member>
 		<member name="anim_offset_curve" type="Texture2D" setter="set_param_texture" getter="get_param_texture">
 			Each particle's animation offset will vary along this [CurveTexture].
diff --git a/doc/classes/PhysicsDirectBodyState2D.xml b/doc/classes/PhysicsDirectBodyState2D.xml
index fbadfd2702a..9921974c6e8 100644
--- a/doc/classes/PhysicsDirectBodyState2D.xml
+++ b/doc/classes/PhysicsDirectBodyState2D.xml
@@ -208,7 +208,7 @@
 	</methods>
 	<members>
 		<member name="angular_velocity" type="float" setter="set_angular_velocity" getter="get_angular_velocity">
-			The body's rotational velocity.
+			The body's rotational velocity in [i]radians[/i] per second.
 		</member>
 		<member name="center_of_mass" type="Vector2" setter="" getter="get_center_of_mass">
 			The body's center of mass position relative to the body's center in the global coordinate system.
@@ -223,7 +223,7 @@
 			The inverse of the mass of the body.
 		</member>
 		<member name="linear_velocity" type="Vector2" setter="set_linear_velocity" getter="get_linear_velocity">
-			The body's linear velocity.
+			The body's linear velocity in pixels per second.
 		</member>
 		<member name="sleeping" type="bool" setter="set_sleep_state" getter="is_sleeping">
 			If [code]true[/code], this body is currently sleeping (not active).
diff --git a/doc/classes/PhysicsDirectBodyState3D.xml b/doc/classes/PhysicsDirectBodyState3D.xml
index 58c4294d66e..77c99c55b1c 100644
--- a/doc/classes/PhysicsDirectBodyState3D.xml
+++ b/doc/classes/PhysicsDirectBodyState3D.xml
@@ -215,7 +215,7 @@
 	</methods>
 	<members>
 		<member name="angular_velocity" type="Vector3" setter="set_angular_velocity" getter="get_angular_velocity">
-			The body's rotational velocity.
+			The body's rotational velocity in [i]radians[/i] per second.
 		</member>
 		<member name="center_of_mass" type="Vector3" setter="" getter="get_center_of_mass">
 			The body's center of mass position relative to the body's center in the global coordinate system.
@@ -230,7 +230,7 @@
 			The inverse of the mass of the body.
 		</member>
 		<member name="linear_velocity" type="Vector3" setter="set_linear_velocity" getter="get_linear_velocity">
-			The body's linear velocity.
+			The body's linear velocity in units per second.
 		</member>
 		<member name="principal_inertia_axes" type="Basis" setter="" getter="get_principal_inertia_axes">
 		</member>
diff --git a/doc/classes/RigidDynamicBody2D.xml b/doc/classes/RigidDynamicBody2D.xml
index 0026c496515..b3644711a02 100644
--- a/doc/classes/RigidDynamicBody2D.xml
+++ b/doc/classes/RigidDynamicBody2D.xml
@@ -121,7 +121,7 @@
 			Defines how [member angular_damp] is applied. See [enum DampMode] for possible values.
 		</member>
 		<member name="angular_velocity" type="float" setter="set_angular_velocity" getter="get_angular_velocity" default="0.0">
-			The body's rotational velocity.
+			The body's rotational velocity in [i]radians[/i] per second.
 		</member>
 		<member name="can_sleep" type="bool" setter="set_can_sleep" getter="is_able_to_sleep" default="true">
 			If [code]true[/code], the body can enter sleep mode when there is no movement. See [member sleeping].
@@ -179,7 +179,7 @@
 			Defines how [member linear_damp] is applied. See [enum DampMode] for possible values.
 		</member>
 		<member name="linear_velocity" type="Vector2" setter="set_linear_velocity" getter="get_linear_velocity" default="Vector2(0, 0)">
-			The body's linear velocity.
+			The body's linear velocity in pixels per second. Can be used sporadically, but [b]don't set this every frame[/b], because physics may run in another thread and runs at a different granularity. Use [method _integrate_forces] as your process loop for precise control of the body state.
 		</member>
 		<member name="lock_rotation" type="bool" setter="set_lock_rotation_enabled" getter="is_lock_rotation_enabled" default="false">
 			If [code]true[/code], the body cannot rotate. Gravity and forces only apply linear movement.
diff --git a/doc/classes/RigidDynamicBody3D.xml b/doc/classes/RigidDynamicBody3D.xml
index 3dffdcbf830..16fced737f2 100644
--- a/doc/classes/RigidDynamicBody3D.xml
+++ b/doc/classes/RigidDynamicBody3D.xml
@@ -127,7 +127,7 @@
 			Defines how [member angular_damp] is applied. See [enum DampMode] for possible values.
 		</member>
 		<member name="angular_velocity" type="Vector3" setter="set_angular_velocity" getter="get_angular_velocity" default="Vector3(0, 0, 0)">
-			RigidDynamicBody3D's rotational velocity.
+			The RigidDynamicBody3D's rotational velocity in [i]radians[/i] per second.
 		</member>
 		<member name="can_sleep" type="bool" setter="set_can_sleep" getter="is_able_to_sleep" default="true">
 			If [code]true[/code], the body can enter sleep mode when there is no movement. See [member sleeping].
@@ -185,7 +185,7 @@
 			Defines how [member linear_damp] is applied. See [enum DampMode] for possible values.
 		</member>
 		<member name="linear_velocity" type="Vector3" setter="set_linear_velocity" getter="get_linear_velocity" default="Vector3(0, 0, 0)">
-			The body's linear velocity. Can be used sporadically, but [b]don't set this every frame[/b], because physics may run in another thread and runs at a different granularity. Use [method _integrate_forces] as your process loop for precise control of the body state.
+			The body's linear velocity in units per second. Can be used sporadically, but [b]don't set this every frame[/b], because physics may run in another thread and runs at a different granularity. Use [method _integrate_forces] as your process loop for precise control of the body state.
 		</member>
 		<member name="lock_rotation" type="bool" setter="set_lock_rotation_enabled" getter="is_lock_rotation_enabled" default="false">
 			If [code]true[/code], the body cannot rotate. Gravity and forces only apply linear movement.