Skip to content

Commit

Permalink
Improve Shape docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
Argmaster committed Aug 19, 2024
1 parent 8c0bef6 commit bbe7be9
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion src/pygerber/vm/commands/shape.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,13 @@ class ShapeSegment(BaseModel):


class Shape(Command):
"""Draw a line from the current position to the given position."""
"""`Shape` command instructs VM to render a shape described by series of
lines and arcs into currently active layer.
Last point of first segment (line or arc) is always connected to the first point
first segment, so shapes are implicitly closed. If those points are not overlapping,
they are connected by a straight line.
"""

commands: List[ShapeSegment]
negative: bool = False
Expand Down

0 comments on commit bbe7be9

Please sign in to comment.