From ed4dfba1ec9d5461b8f26445f6232707d78d75b8 Mon Sep 17 00:00:00 2001 From: Slava Pestov Date: Sun, 14 Nov 2010 19:29:37 -0800 Subject: [PATCH] path-finding: fix help lint --- extra/path-finding/path-finding-docs.factor | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/extra/path-finding/path-finding-docs.factor b/extra/path-finding/path-finding-docs.factor index a41959db69..c282aa1dc0 100644 --- a/extra/path-finding/path-finding-docs.factor +++ b/extra/path-finding/path-finding-docs.factor @@ -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 { } related-words @@ -45,7 +45,7 @@ HELP: { "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: HELP: { $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: HELP: { $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 "