LP#1976126: (follow-up) update method documentation

This patch updates the open-ils.actor.patron.update method
documentation to explicitly state that updates to patron notes,
user activity, and standing penalities via that method are
ignored. This is to try to avoid a regression on this bug, as
otherwise it might be plausible for the method to allow the notes
and standing penalties (at least) to be updated.

Signed-off-by: Galen Charlton <gmc@equinoxOLI.org>

diff --git a/Open-ILS/src/perlmods/lib/OpenILS/Application/Actor.pm b/Open-ILS/src/perlmods/lib/OpenILS/Application/Actor.pm
index 56df630..da0c9d7 100644 (file)
--- a/Open-ILS/src/perlmods/lib/OpenILS/Application/Actor.pm
+++ b/Open-ILS/src/perlmods/lib/OpenILS/Application/Actor.pm
@@ -509,6 +509,11 @@ __PACKAGE__->register_method(
             attached object, indicate if the object should be created,
             updated, or deleted using the built-in 'isnew', 'ischanged',
             and 'isdeleted' fields on the object.
+            This method intentionally does not handle updates to patron
+            notes, user activity, and standing penalties; if any values
+            are supplied for those fields in the patron data object,
+            they will be ignored. Please refer to bug 1976126 before
+            changing this.
         /,
         params => [
             { desc => 'Authentication token', type => 'string' },