8000 add doco about closed parameter · rocsys/spatialmath-python@c82b2ad · GitHub
[go: up one dir, main page]

Skip to content 8000

Commit c82b2ad

Browse files
committed
add doco about closed parameter
1 parent c83ddd2 commit c82b2ad

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

spatialmath/base/graphics.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -546,6 +546,8 @@ def circle(
546546
:type radius: float, optional
547547
:param resolution: number of points on circumferece, defaults to 50
548548
:type resolution: int, optional
549+
:param closed: perimeter is closed, last point == first point, defaults to False
550+
:type closed: bool
549551
:return: points on circumference
550552
:rtype: ndarray(2,N) or ndarray(3,N)
551553
@@ -661,6 +663,8 @@ def ellipse(
661663
:type resolution: int, optional
662664
:param inverted: if :math:`\mat{E}^{-1}` is provided, defaults to False
663665
:type inverted: bool, optional
666+
:param closed: perimeter is closed, last point == first point, defaults to False
667+
:type closed: bool
664668
:raises ValueError: [description]
665669
:return: points on circumference
666670
:rtype: ndarray(2,N)

0 commit comments

Comments
 (0)
0