pingu_98/MrDraw
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added info to the hook's docs

Browse source
This commit is contained in:
Nicanor Romero Venier 2015-09-07 10:52:03 +02:00
parent fa95507177
commit 74b0056095
1 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/plugins/hooks.rst
View file

@ -167,7 +167,9 @@ octoprint.comm.protocol.gcode.received
.. py:function:: hook(comm_instance, line, *args, **kwargs)
Get the returned lines sent by the printer. Handlers should return the received line or in any case, the modified
version of it.
version of it. If the the handler returns None, processing will be aborted and the communication layer will get an
empty string as the received line. Note that Python functions will also automatically return ``None`` if an empty
``return`` statement is used or just nothing is returned explicitely from the handler.
**Example:**