Bug 14538: editing perl doc for CalcFine

To Test:
Read perldoc C4/Overdues.pm
Confirm that it says CalcFine returns four values and that rest of the documentation is correct

NOTE: only a little visual ugliness, but definitely an improvement.

Signed-off-by: Mark Tompsett <mtompset@hotmail.com>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>

Signed-off-by: Jesse Weaver <jweaver@bywatersolutions.com>
This commit is contained in:
Natasha 2016-01-18 22:59:03 +00:00 committed by Jesse Weaver
parent cd3b3afcd2
commit f1bbc3d2a1

View file

@ -204,7 +204,7 @@ sub checkoverdues {
=head2 CalcFine
($amount, $chargename, $daycounttotal) = &CalcFine($item,
($amount, $chargename, $units_minus_grace, $chargeable_units) = &CalcFine($item,
$categorycode, $branch,
$start_dt, $end_dt );
@ -236,10 +236,10 @@ C<$amount> is the fine owed by the patron (see above).
C<$chargename> is the chargename field from the applicable record in
the categoryitem table, whatever that is.
C<$unitcount> is the number of chargeable units (days between start and end dates, Calendar adjusted where needed,
minus any applicable grace period, or hours)
C<$units_minus_grace> is the number of chargeable units minus the grace period
FIXME - What is chargename supposed to be ?
C<$chargeable_units> is the number of chargeable units (days between start and end dates, Calendar adjusted where needed,
minus any applicable grace period, or hours)
FIXME: previously attempted to return C<$message> as a text message, either "First Notice", "Second Notice",
or "Final Notice". But CalcFine never defined any value.