steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add some documentation precisions for astar

release
Samuel Tardieu 2010-03-23 09:30:48 +01:00
parent 14d1da94bb
commit f62d414bd1
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
extra/astar/astar-docs.factor
View 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:"