Bug 22098: (QA follow-up) Improving documentation

Improves the documentation of the script a bit, but makes one
important change:

-If no prefix is submitted, or prefix does not contain only
-numbers, it returns the inserted code (= keep a field unchanged)
+If no prefix is submitted, or the prefix does contain only
+numbers, it returns the inserted code (= keep the field unchanged).

To test:
- Add an authorised INVENTORY value with 2020 as prefix
- After linking the stocknumberAV.pl to the 952$i in the frameworks
- Edit an item
- Add 2020 in the stocknumber field
- Trigger plugin
- Verify nothing happens

If the prefix contains only numbers... nothing happens.

Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>

diff --git a/cataloguing/value_builder/stocknumberAV.pl b/cataloguing/value_builder/stocknumberAV.pl
index 3bf94da..f0e35d4 100755 (executable)
--- a/cataloguing/value_builder/stocknumberAV.pl
+++ b/cataloguing/value_builder/stocknumberAV.pl
@@ -28,18 +28,18 @@ use Koha::AuthorisedValues;
 
 =head1 DESCRIPTION
 
-This plugin is based on authorised values INVENTORY.
+This plugin is based on authorised values from INVENTORY.
 It is used for stocknumber computation.
 
-If no prefix is submitted, or prefix does not contain only
-numbers, it returns the inserted code (= keep a field unchanged)
+If no prefix is submitted, or the prefix does contain only
+numbers, it returns the inserted code (= keep the field unchanged).
 
-If a prefix is submited, we look for the highest stocknumber
-with this prefix, and return it incremented.
+If a prefix is submitted, we look for the highest stocknumber
+with this prefix and return it incremented.
 
 In this case, a stocknumber has this form (e.g. "PREFIX 0009678570"):
-PREFIX containing letters, a space separator, and
-10 digits with leading 0s if needed
+PREFIX containing letters, a space separator and 10 digits with leading
+0s if needed.
 
 =cut