inventree/inventree-docs
2
0
Fork 0
mirror of https://github.com/inventree/inventree-docs.git synced 2025-04-28 13:46:54 +00:00
Code

add footnotes

Browse Source
This commit is contained in:
Matthias Mair 2022-01-19 00:22:22 +01:00
parent 11ac217f7d
commit 85d3c6e8a9
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/extend/how_to_plugin.md
View File

@ -50,15 +50,15 @@ from plugin.mixins import APICallMixin, SettingsMixin, ScheduleMixin, BarcodeMix
### A simple example ### A simple example
This example adds a new action under `/api/action/sample` using the ActionMixin. This example adds a new action under `/api/action/sample` using the ActionMixin.
``` python ``` python
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*- # (1)
"""sample implementation for ActionPlugin""" """sample implementation for ActionPlugin""" # (2)
from plugin import IntegrationPluginBase from plugin import IntegrationPluginBase
from plugin.mixins import ActionMixin from plugin.mixins import ActionMixin
class SampleActionPlugin(ActionMixin, IntegrationPluginBase): class SampleActionPlugin(ActionMixin, IntegrationPluginBase):
""" """
Use docstrings for everything... pls Use docstrings for everything... pls # (2)
""" """
PLUGIN_NAME = "SampleActionPlugin" PLUGIN_NAME = "SampleActionPlugin"
@ -85,3 +85,7 @@ class SampleActionPlugin(ActionMixin, IntegrationPluginBase):
def get_result(self): def get_result(self):
return True # This is returned to the client return True # This is returned to the client
``` ```
1. It is recommended to put each plugin into it's own file, this is not required
2. Please document you functions and classes - following PEP8 or black is recommended