[open-ils-commits] r18818 - trunk/Open-ILS/src/perlmods/OpenILS/Application/Storage/Publisher (gmc)

[svn at svn.open-ils.org]

Author: gmc
Date: 2010-11-22 08:36:54 -0500 (Mon, 22 Nov 2010)
New Revision: 18818

Modified:
   trunk/Open-ILS/src/perlmods/OpenILS/Application/Storage/Publisher/action.pm
Log:
document a potential gotcha for users of open-ils.storage.action.circulation.overdue

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

Modified: trunk/Open-ILS/src/perlmods/OpenILS/Application/Storage/Publisher/action.pm
===================================================================
--- trunk/Open-ILS/src/perlmods/OpenILS/Application/Storage/Publisher/action.pm	2010-11-22 13:17:57 UTC (rev 18817)
+++ trunk/Open-ILS/src/perlmods/OpenILS/Application/Storage/Publisher/action.pm	2010-11-22 13:36:54 UTC (rev 18818)
@@ -278,8 +278,13 @@
 __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',