Merge pull request #82544 from MewPurPur/improve-ray-docs

Improve SeparationRayShape docs
godotengine · Oct 3, 2023 · 19c72e8 · 19c72e8
2 parents 2af3229 + c4db6e1
commit 19c72e8
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/doc/classes/SeparationRayShape2D.xml b/doc/classes/SeparationRayShape2D.xml
@@ -4,7 +4,7 @@
  A 2D ray shape used for physics collision that tries to separate itself from any collider.
  </brief_description>
  <description>
- A 2D ray shape, intended for use in physics. Usually used to provide a shape for a [CollisionShape2D]. When a [SeparationRayShape2D] collides with an object, it tries to separate itself from it by moving its endpoint to the collision point. It can for example be used for spears falling from the sky.
+ A 2D ray shape, intended for use in physics. Usually used to provide a shape for a [CollisionShape2D]. When a [SeparationRayShape2D] collides with an object, it tries to separate itself from it by moving its endpoint to the collision point. For example, a [SeparationRayShape2D] next to a character can allow it to instantly move up when touching stairs.
  </description>
  <tutorials>
  </tutorials>

diff --git a/doc/classes/SeparationRayShape3D.xml b/doc/classes/SeparationRayShape3D.xml
@@ -4,7 +4,7 @@
  A 3D ray shape used for physics collision that tries to separate itself from any collider.
  </brief_description>
  <description>
- A 3D ray shape, intended for use in physics. Usually used to provide a shape for a [CollisionShape3D]. When a [SeparationRayShape3D] collides with an object, it tries to separate itself from it by moving its endpoint to the collision point. It can for example be used for spears falling from the sky.
+ A 3D ray shape, intended for use in physics. Usually used to provide a shape for a [CollisionShape3D]. When a [SeparationRayShape3D] collides with an object, it tries to separate itself from it by moving its endpoint to the collision point. For example, a [SeparationRayShape3D] next to a character can allow it to instantly move up when touching stairs.
  </description>
  <tutorials>
  </tutorials>