Reformat

[factor.git] / basis / syndication / syndication-docs.factor

diff --git a/basis/syndication/syndication-docs.factor b/basis/syndication/syndication-docs.factor
index 5604a94dbdca787c27719e1b3dcb95dfdeab6158..3e9ce7835231bada8431925818b83d60bb28a131 100644 (file)
--- a/basis/syndication/syndication-docs.factor
+++ b/basis/syndication/syndication-docs.factor
@@ -1,11 +1,11 @@
-USING: help.markup help.syntax io.streams.string strings urls
-calendar xml.data xml.writer present ;
+USING: calendar help.markup help.syntax present strings urls
+xml.data xml.writer ;
 IN: syndication
 
 HELP: entry
 { $description "An Atom or RSS feed entry. Has the following slots:"
     { $table
-        { "Name" "Class" }
+        { { $strong "Name" } { $strong "Class" } }
         { "title" { $link string } }
         { "url" { "any class supported by " { $link present } } }
         { "description" { $link string } }
@@ -20,7 +20,7 @@ HELP: <entry>
 HELP: feed
 { $description "An Atom or RSS feed. Has the following slots:"
     { $table
-        { "Name" "Class" }
+        { { $strong "Name" } { $strong "Class" } }
         { "title" { $link string } }
         { "url" { "any class supported by " { $link present } } }
         { "entries" { "a sequence of " { $link entry } " instances" } }
@@ -35,9 +35,9 @@ HELP: download-feed
 { $values { "url" url } { "feed" feed } }
 { $description "Downloads a feed from a URL using the " { $link "http.client" } "." } ;
 
-HELP: string>feed
-{ $values { "string" string } { "feed" feed } }
-{ $description "Parses a feed in string form." } ;
+HELP: parse-feed
+{ $values { "seq" "a string or a byte array" } { "feed" feed } }
+{ $description "Parses a feed." } ;
 
 HELP: xml>feed
 { $values { "xml" xml } { "feed" feed } }
@@ -52,16 +52,20 @@ ARTICLE: "syndication" "Atom and RSS feed syndication"
 "The " { $vocab-link "syndication" } " vocabulary implements support for reading Atom and RSS feeds, and writing Atom feeds."
 $nl
 "Data types:"
-{ $subsection feed }
-{ $subsection <feed> }
-{ $subsection entry }
-{ $subsection <entry> }
+{ $subsections
+    feed
+    <feed>
+    entry
+    <entry>
+}
 "Reading feeds:"
-{ $subsection download-feed }
-{ $subsection string>feed }
-{ $subsection xml>feed }
+{ $subsections
+    download-feed
+    parse-feed
+    xml>feed
+}
 "Writing feeds:"
-{ $subsection feed>xml }
+{ $subsections feed>xml }
 "The " { $vocab-link "furnace.syndication" } " vocabulary builds on top of this vocabulary to enable easy generation of Atom feeds from web applications. The " { $vocab-link "webapps.planet" } " vocabulary is a complete example of a web application which reads and exports feeds."
 { $see-also "urls" } ;