Skip to content

Commit 44ab4fc

Browse files
XFajkaatle
andauthored
Update docs/reST/ref/geometry.rst
clarify the docs for the Line.project methdo Co-authored-by: aatle <[email protected]>
1 parent ea76d39 commit 44ab4fc

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

docs/reST/ref/geometry.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -747,7 +747,8 @@
747747
| :sg:`project(point: tuple[float, float], clamp=False) -> tuple[float, float]`
748748
749749
This method takes in a point and one boolean keyword argument clamp. It outputs an orthogonally projected point onto the line.
750-
If clamp is True it makes sure that the outputted point will be on the line segment.
750+
If clamp is `True` it makes sure that the outputted point will be on the line segment (which might not be orthogonal), and if it is `False` (the default) then any point on the infinitely extended line may be outputted.
751+
This method can be used to find the closest point on a line to the given point. The output is the unique point on the line or line segment that is the smallest distance away from the given point.
751752

752753

753754
.. figure:: code_examples/project.png

0 commit comments

Comments
 (0)