Bug 23185: Realistic POD for Koha::Objects->search

Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>

diff --git a/Koha/Objects.pm b/Koha/Objects.pm
index c19ced5..2bf3391 100644 (file)
--- a/Koha/Objects.pm
+++ b/Koha/Objects.pm
@@ -118,9 +118,21 @@ sub find_or_create {
     return $object;
 }
 
-=head3 Koha::Objects->search();
+=head3 search
+
+    # list context
+    my @objects = Koha::Objects->search([$params, $attributes]);
+    # scalar context
+    my $objects = Koha::Objects->search([$params, $attributes]);
+    while (my $object = $objects->next) {
+        do_stuff($object);
+    }
+
+This B<instantiates> the I<Koha::Objects> class, and generates a resultset
+based on the query I<$params> and I<$attributes> that are passed (like in DBIC).
 
-my @objects = Koha::Objects->search($params);
+In B<list context> it returns an array of I<Koha::Object> objects.
+In B<scalar context> it returns an iterator.
 
 =cut