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

Use better name than "hook" for various plugin hook documentation

Browse source
This commit is contained in:
Gina Häußge 2016-09-20 10:29:53 +02:00
parent c7055440cc
commit 0ac3881897
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/plugins/hooks.rst
View file

@ -231,7 +231,7 @@ octoprint.accesscontrol.appkey
octoprint.cli.commands
~~~~~~~~~~~~~~~~~~~~~~
.. py:function:: hook(cli_group, pass_octoprint_ctx, *args, **kwargs)
.. py:function:: cli_commands_hook(cli_group, pass_octoprint_ctx, *args, **kwargs)
By providing a handler for this hook plugins may register commands on OctoPrint's command line interface (CLI).
@ -476,7 +476,7 @@ This describes actually four hooks:
octoprint.comm.protocol.gcode.received
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. py:function:: hook(comm_instance, line, *args, **kwargs)
.. py:function:: gcode_received_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. If the the handler returns None, processing will be aborted and the communication layer will get an
@ -682,7 +682,7 @@ octoprint.filemanager.preprocessor
octoprint.printer.factory
~~~~~~~~~~~~~~~~~~~~~~~~~
.. py:function:: hook(components, *args, **kwargs)
.. py:function:: printer_factory_hook(components, *args, **kwargs)
Return a :class:`~octoprint.printer.PrinterInstance` instance to use as global printer object. This will
be called only once during initial server startup.