From f742f32804badf557043ea0e453b33c0bc951dce Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Tue, 14 Apr 2020 22:33:03 +1000 Subject: [PATCH] Added some doc string --- InvenTree/plugins/barcode/inventree.py | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/InvenTree/plugins/barcode/inventree.py b/InvenTree/plugins/barcode/inventree.py index 231edfe189..a9125ed8a8 100644 --- a/InvenTree/plugins/barcode/inventree.py +++ b/InvenTree/plugins/barcode/inventree.py @@ -1,3 +1,14 @@ +""" +The InvenTreeBarcodePlugin validates barcodes generated by InvenTree itself. +It can be used as a template for developing third-party barcode plugins. + +The data format is very simple, and maps directly to database objects, +via the "id" parameter. + +Parsing an InvenTree barcode simply involves validating that the +references model objects actually exist in the database. +""" + # -*- coding: utf-8 -*- from . import barcode @@ -68,4 +79,3 @@ class InvenTreeBarcodePlugin(barcode.BarcodePlugin): response['error'] = _('No matching data') return response -