From: gmc Date: Mon, 22 Nov 2010 13:36:54 +0000 (+0000) Subject: document a potential gotcha for users of open-ils.storage.action.circulation.overdue X-Git-Url: https://old-git.evergreen-ils.org/?a=commitdiff_plain;h=d709b19d367a4cdc1f4ace34534a658cc65d2030;p=evergreen%2Fpines.git document a potential gotcha for users of open-ils.storage.action.circulation.overdue Signed-off-by: Galen Charlton 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 7697937f2a..b925fd4074 100644 --- 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',