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

path-finding: fix help lint

db4
Slava Pestov 2010-11-14 19:29:37 -08:00
parent 97a8e889c3
commit c412237dc4
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
extra/path-finding/path-finding-docs.factor
View File

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