Skip to content

Commit

Permalink
opencsp/common/lib/cv/annotations: test docs
Browse files Browse the repository at this point in the history
  • Loading branch information
e10harvey committed Nov 12, 2024
1 parent 1de16ec commit b12687f
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 0 deletions.
3 changes: 3 additions & 0 deletions opencsp/common/lib/cv/annotations/HotspotAnnotation.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ class HotspotAnnotation(PointAnnotations):
The point location of the hotspot annotation.
"""

# "ChatGPT 4o" assisted with generating this docstring.

def __init__(self, style: rcps.RenderControlPointSeq = None, point: p2.Pxy = None):
"""
A class representing a hotspot annotation in a graphical context.
Expand Down Expand Up @@ -45,6 +47,7 @@ def __init__(self, style: rcps.RenderControlPointSeq = None, point: p2.Pxy = Non
>>> print(hotspot_with_point.point)
Pxy(10, 20)
"""
# "ChatGPT 4o" assisted with generating this docstring.
if style is None:
style = rcps.RenderControlPointSeq(color='blue', marker='x', markersize=1)
super().__init__(style, point)
2 changes: 2 additions & 0 deletions opencsp/common/lib/cv/annotations/PointAnnotations.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,6 @@ class PointAnnotations(pf.PointFiducials, AbstractAnnotations):
AbstractAnnotations : Provides an abstract base for annotation classes.
"""

# "ChatGPT 4o" assisted with generating this docstring.

pass

0 comments on commit b12687f

Please sign in to comment.