Bug 25552: (QA follow-up) Improve claim_returned POD

The POD for the Koha::Checkout->claim_returned method was somewhat
lacking; This patch attempts to explain what the code appears to
achieve.

Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
This commit is contained in:
Martin Renvoize 2021-01-22 12:56:02 +00:00 committed by Jonathan Druart
parent cd7a3e6ccb
commit 8c09123197
1 changed files with 11 additions and 1 deletions

View File

@ -145,7 +145,17 @@ sub to_api_mapping {
=head3 claim_returned
my $return_claim = $checkout->claim_returned();
my $return_claim = $checkout->claim_returned();
This method sets the checkout as claimed return. It will:
1. Add a new row to the `return_claims` table
2. Set the item as lost using the 'ClaimReturnedLostValue'
3. Charge a fee depending on the value of ClaimReturnedChargeFee
3a. If set to charge, then accruing overdues will be halted
3b. If set to charge, then any existing transfers will be cancelled
and the holding branch will be set back to 'frombranch'.
4. The issue will be marked as returned as per the 'MarkLostItemsAsReturned' preference
=cut