Skip to content

Commit 06bc95b

Browse files
committed
Correct gwrite DocString
1 parent 1ea6acf commit 06bc95b

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

vpype_gcode/gwrite.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,12 @@ def invert_axis(document: vp.Document, invert_x: bool, invert_y: bool):
4545
)
4646
@vp.global_processor
4747
def gwrite(document: vp.Document, output: typing.TextIO, profile: str):
48+
"""
49+
Write gcode files for the vpype pipeline.
50+
51+
The output format can be customized by the user heavily to an extent that you can also output most known
52+
non-gcode ascii text files.
53+
"""
4854
gwrite_config = vp.CONFIG_MANAGER.config["gwrite"]
4955

5056
# If no profile was provided, try to use a default

0 commit comments

Comments
 (0)