Bug 21909: Add return type explanation to POD
authorTomas Cohen Arazi <tomascohen@theke.io>
Thu, 29 Nov 2018 15:15:33 +0000 (12:15 -0300)
committerMartin Renvoize <martin.renvoize@ptfs-europe.com>
Mon, 7 Jan 2019 15:01:30 +0000 (15:01 +0000)
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>

Signed-off-by: Josef Moravec <josef.moravec@gmail.com>

Signed-off-by: Nick Clemens <nick@bywatersolutions.com>
(cherry picked from commit 94bdfc2beee9da1ed3b8159e211272a42d01e4fa)
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>

Koha/Account.pm

index 304d0e2..eeb87a5 100644 (file)
@@ -423,6 +423,11 @@ sub balance {
 
 my $lines = Koha::Account->new({ patron_id => $patron_id })->outstanding_debits;
 
+It returns the debit lines with outstanding amounts for the patron.
+
+In scalar context, it returns a Koha::Account::Lines iterator. In list context, it will
+return a list of Koha::Account::Line objects.
+
 =cut
 
 sub outstanding_debits {
@@ -440,6 +445,11 @@ sub outstanding_debits {
 
 my $lines = Koha::Account->new({ patron_id => $patron_id })->outstanding_credits;
 
+It returns the credit lines with outstanding amounts for the patron.
+
+In scalar context, it returns a Koha::Account::Lines iterator. In list context, it will
+return a list of Koha::Account::Line objects.
+
 =cut
 
 sub outstanding_credits {