extra/tools/crossref/crossref-docs.factor

   1 USING: help.markup help.syntax words definitions ;
   2 IN: tools.crossref
   3
   4 ARTICLE: "tools.crossref" "Cross-referencing tools"
   5 { $subsection usage. }
   6 { $subsection apropos }
   7 { $see-also "definitions" "words" } ;
   8
   9 ABOUT: "tools.crossref"
  10
  11 HELP: usage.
  12 { $values { "word" "a word" } }
  13 { $description "Prints an list of all callers of a word. This may include the word itself, if it is recursive." }
  14 { $examples { $code "\\ reverse usage." } } ;
  15
  16 { usage usage. } related-words
  17
  18 HELP: apropos
  19 { $values { "str" "a string" } }
  20 { $description "Lists all words whose name contains a subsequence equal to " { $snippet "str" } ". Results are ranked using a simple distance algorithm." } ;