document a potential gotcha for users of open-ils.storage.action.circulation.overdue

Signed-off-by: Galen Charlton <gmc@esilibrary.com>

git-svn-id: svn://svn.open-ils.org/ILS/trunk@18818 dcc99617-32d9-48b4-a31d-7c20da2025e4

diff --git a/Open-ILS/src/perlmods/OpenILS/Application/Storage/Publisher/action.pm b/Open-ILS/src/perlmods/OpenILS/Application/Storage/Publisher/action.pm
index 7697937..b925fd4 100644 (file)
--- a/Open-ILS/src/perlmods/OpenILS/Application/Storage/Publisher/action.pm
+++ b/Open-ILS/src/perlmods/OpenILS/Application/Storage/Publisher/action.pm
@@ -278,8 +278,13 @@ sub grab_overdue {
 __PACKAGE__->register_method(
        api_name        => 'open-ils.storage.action.circulation.overdue',
        api_level       => 1,
-       stream          => 1,
+       stream              => 1,
        method          => 'grab_overdue',
+       signature       => q/
+               Return list of overdue circulations and reservations to be used for fine generation.
+               Despite the name, this is not a generic method for retrieving all overdue loans,
+               as it excludes loans that have already hit the maximum fine limit.
+/,
 );
 __PACKAGE__->register_method(
        api_name        => 'open-ils.storage.action.circulation.overdue.id_list',