Changeset 6 in mp3-find for trunk

Timestamp:

01/31/06 14:43:55 (18 years ago)

Author:

peter

Message:

• doc clarification for find_mp3s (suggestion fr. Michael Slass)

Location:

trunk

Files:

• Changes (modified) (1 diff)
• lib/MP3/Find.pm (modified) (3 diffs)

trunk/Changes

@@ -3 +3 @@
 0.01  29 Jan 2006
     - first CPAN release
+
+0.02
+    - doc updates (thanks to Michael Slass for the suggestion)
+

trunk/lib/MP3/Find.pm

@@ -89 +89 @@
 =item C<dir>
 
-Where to start the search. This can either be a single string or
-an arrayref. Defaults to your home directory.
+Arrayref or scalar; tell C<find_mp3s> where to start the search.
+Directories in the arrayref are searched sequentially.
 
 =item C<query>
@@ -98 +98 @@
 or lower case; C<find_mp3s> will convert them into upper case for 
 you. Value may either be strings, which are converted into regular
-exporessions, or may be C<qr[...]> regular expressions already.
+exporessions, or may be C<qr/.../> regular expressions already.
 
 =item C<ignore_case>
 
-Ignore case when matching search strings to the ID3 tag values.
+Boolean, default false; set to a true value to ignore case when
+matching search strings to the ID3 tag values.
 
 =item C<exact_match>
 
-Adds an implicit C<^> and C<$> around each query string. Does nothing
-if the query is already a regular expression.
+Boolean, default false; set to a true value to add an implicit
+C<^> and C<$> around each query string. Does nothing if the query
+term is already a regular expression.
 
 =item C<sort>
@@ -138 +140 @@
 =item C<no_format>
 
-Causes C<find_mp3s> to return an array of hashrefs instead of an array
-of (formatted) strings. Each hashref consists of the key-value pairs
-from C<MP3::Info::get_mp3_tag> and C<MP3::Info::get_mp3_info>, plus
-the key C<FILENAME> (with the obvious value ;-)
+Boolean, default false; set to a true value to have C<find_mp3s> to
+return an array of hashrefs instead of an array of (formatted) strings.
+Each hashref consists of the key-value pairs from C<MP3::Info::get_mp3_tag>
+and C<MP3::Info::get_mp3_info>, plus the key C<FILENAME> (with the obvious 
+value ;-)
 
     @results = (