spiff up id3 docs a bit, and fix help-lint

diff --git a/extra/id3/id3-docs.factor b/extra/id3/id3-docs.factor
index 94128dc3b28dd6db49d8d6c3c339436ebaea3f0e..da69c2ced3746bf58de9f059d74f2c0e8e7db7de 100644 (file)
--- a/extra/id3/id3-docs.factor
+++ b/extra/id3/id3-docs.factor
@@ -3,15 +3,15 @@
 USING: help.markup help.syntax sequences kernel ;
 IN: id3
 
-HELP: id3-parse-mp3-file
+HELP: file-id3-tags
 { $values 
     { "path" "a path string" } 
-    { "object/f" "either a tuple consisting of the data from an MP3 file, or an f indicating this file has no (supported) ID3 information." } }
-{ $description "Return a tuple containing the ID3 information parsed out of the MP3 file" } ;
+    { "object/f" "a tuple storing ID3 metadata or f" } }
+{ $description "Return a tuple containing the ID3 information parsed out of the MP3 file, or " { $link f } " if no metadata is present." } ;
 
 ARTICLE: "id3" "ID3 tags"
-{ $emphasis "ID3" } " tags are textual data that is used to describe the information (title, artist, etc.) in an .MP3 file"
-"Parsing an MP3 file: "
-{ $subsection id3-parse-mp3-file } ;
+"The " { $vocab-link "id3" } " vocabulary contains words for parsing " { $emphasis "ID3" } " tags, which are textual fields storing an MP3's title, artist, and other metadata." $nl
+"Parsing ID3 tags from an MP3 file:"
+{ $subsection file-id3-tags } ;
 
 ABOUT: "id3"

diff --git a/extra/id3/id3-tests.factor b/extra/id3/id3-tests.factor
index d84f2c87260dedb2c9975f3a319b04441d41e740..b9d45b1b04fc1af9fd93a667b1f71407d40d7230 100644 (file)
--- a/extra/id3/id3-tests.factor
+++ b/extra/id3/id3-tests.factor
@@ -58,7 +58,7 @@ IN: id3.tests
        }
      }
 }
-] [ "resource:extra/id3/tests/blah3.mp3" id3-parse-mp3-file ] unit-test
+] [ "resource:extra/id3/tests/blah3.mp3" file-id3-tags ] unit-test
 
 [
     T{ mp3v2-file
@@ -159,7 +159,7 @@ IN: id3.tests
         }
     }
 }
-] [ "resource:extra/id3/tests/blah2.mp3" id3-parse-mp3-file ] unit-test
+] [ "resource:extra/id3/tests/blah2.mp3" file-id3-tags ] unit-test
 
 [    
   T{ mp3v1-file
@@ -178,5 +178,5 @@ IN: id3.tests
      }
      { genre 89 }
   }
-] [ "resource:extra/id3/tests/blah.mp3" id3-parse-mp3-file ] unit-test
+] [ "resource:extra/id3/tests/blah.mp3" file-id3-tags ] unit-test
 

diff --git a/extra/id3/id3.factor b/extra/id3/id3.factor
index b2c2ec0621ff226342894c6929e9eab5576bc1c0..64e1ff1d10b498b8778a2ee5716f540a5b929897 100644 (file)
--- a/extra/id3/id3.factor
+++ b/extra/id3/id3.factor
@@ -142,7 +142,7 @@ PRIVATE>
 
 ! main stuff
 
-: id3-parse-mp3-file ( path -- object )
+: file-id3-tags ( path -- object/f )
     [
         {
             { [ dup id3v2? ] [ read-v2-tag-data ] } ! ( ? -- mp3v2-file )