From: Galen Charlton <gmc@esilibrary.com>
Date: Sat, 14 Dec 2013 00:33:25 +0000 (+0000)
Subject: Bug 10852: (follow-up) update the POD for C4::Serials::SearchSubscriptions
X-Git-Url: http://git.rot13.org/?a=commitdiff_plain;h=945dbfc490e7bc8849f7b5f741856131c765cc75;p=koha.git

Bug 10852: (follow-up) update the POD for C4::Serials::SearchSubscriptions

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

diff --git a/C4/Serials.pm b/C4/Serials.pm
index 4175accec8..1e60060950 100644
--- a/C4/Serials.pm
+++ b/C4/Serials.pm
@@ -628,13 +628,27 @@ sub GetSubscriptions {
 
 =head2 SearchSubscriptions
 
-@results = SearchSubscriptions($args);
-$args is a hashref. Its keys can be contained: title, issn, ean, publisher, bookseller and branchcode
-
-this function gets all subscriptions which have title like $title, ISSN like $issn, EAN like $ean, publisher like $publisher, bookseller like $bookseller AND branchcode eq $branch.
-
-return:
-a table of hashref. Each hash containt the subscription.
+  @results = SearchSubscriptions($args);
+
+This function returns a list of hashrefs, one for each subscription
+that meets the conditions specified by the $args hashref.
+
+The valid search fields are:
+
+  biblionumber
+  title
+  issn
+  ean
+  callnumber
+  location
+  publisher
+  bookseller
+  branch
+  expiration_date
+  closed
+
+The expiration_date search field is special; it specifies the maximum
+subscription expiration date.
 
 =cut