]> gitweb.factorcode.org Git - factor.git/commitdiff
path-finding: fix help lint
authorSlava Pestov <slava@slava-pestovs-macbook-pro.local>
Mon, 15 Nov 2010 03:29:37 +0000 (19:29 -0800)
committerSlava Pestov <slava@slava-pestovs-macbook-pro.local>
Mon, 15 Nov 2010 03:29:37 +0000 (19:29 -0800)
extra/path-finding/path-finding-docs.factor

index a41959db69fd27dff77cdc733147024e711cfa40..c282aa1dc0e596cbfcbb4c18a7870d776295f052 100644 (file)
@@ -1,6 +1,6 @@
 ! Copyright (C) 2010 Samuel Tardieu.
 ! See http://factorcode.org/license.txt for BSD license.
-USING: help.markup help.syntax ;
+USING: help.markup help.syntax assocs ;
 IN: path-finding
 
 { <astar> <bfs> <dijkstra> } related-words
@@ -45,7 +45,7 @@ HELP: <astar>
   { "neighbours" "a quotation with stack effect ( node -- seq )" }
   { "cost" "a quotation with stack effect ( from to -- cost )" }
   { "heuristic" "a quotation with stack effect ( pos target -- cost )" }
-  { "astar" "a astar tuple" }
+  { "astar" astar }
 }
 { $description "Build an astar object from the given quotations. The "
   { $snippet "neighbours" } " one builds the list of neighbours. The "
@@ -57,8 +57,8 @@ HELP: <astar>
 
 HELP: <bfs>
 { $values
-  { "neighbours" "an assoc" }
-  { "astar" "a astar tuple" }
+  { "neighbours" assoc }
+  { "astar" astar }
 }
 { $description "Build an astar object from the " { $snippet "neighbours" } " assoc. "
   "When used with " { $link find-path } ", this astar tuple will use the breadth-first search (BFS) "
@@ -67,7 +67,8 @@ HELP: <bfs>
 
 HELP: <dijkstra>
 { $values
-  { "costs" "an assoc" }
+  { "costs" assoc }
+  { "astar" astar }
 }
 { $description "Build an astar object from the " { $snippet "costs" } " assoc. "
   "The assoc keys are edges of the graph, while the corresponding values are assocs whose keys are "
@@ -80,7 +81,7 @@ HELP: find-path
 { $values
   { "start" "a node" }
   { "target" "a node" }
-  { "astar" "a astar tuple" }
+  { "astar" astar }
   { "path/f" "an optimal path from " { $snippet "start" } " to " { $snippet "target" }
     ", or f if no such path exists" }
 }
@@ -90,7 +91,7 @@ HELP: find-path
 
 HELP: considered
 { $values
-  { "astar" "a astar tuple" }
+  { "astar" astar }
   { "considered" "a sequence" }
 }
 { $description "When called after a call to " { $link find-path } ", return a list of nodes "