]> gitweb.factorcode.org Git - factor.git/commitdiff
Add some documentation precisions for astar
authorSamuel Tardieu <sam@rfc1149.net>
Tue, 23 Mar 2010 08:30:48 +0000 (09:30 +0100)
committerSamuel Tardieu <sam@rfc1149.net>
Tue, 23 Mar 2010 08:30:48 +0000 (09:30 +0100)
extra/astar/astar-docs.factor

index d19166c1bf861f4c0b402924b8997b65deb751de..7c474bdb57973e0894121555a7e92bceb57b452b 100644 (file)
@@ -62,8 +62,7 @@ HELP: find-path
     ", or f if no such path exists" }
 }
 { $description "Find a path between " { $snippet "start" } " and " { $snippet "target" }
-  " using the A* algorithm. The " { $snippet "astar" } " tuple must have been previously "
-  " built using " { $link <astar> } "."
+  " using the A* algorithm."
 } ;
 
 HELP: considered
@@ -77,6 +76,7 @@ HELP: considered
 
 ARTICLE: "astar" "A* algorithm"
 "The " { $vocab-link "astar" } " vocabulary implements a graph search algorithm for finding the least-cost path from one node to another." $nl
+"The " { $link astar } " tuple may be derived from and its " { $link cost } ", " { $link heuristic } ", and " { $link neighbours } " methods overwritten, or the " { $link <astar> } " word can be used to build such an object from quotations." $nl
 "Make an A* object:"
 { $subsections <astar> }
 "Find a path between nodes:"