basis/vocabs/files/files-docs.factor

   1 USING: help.markup help.syntax literals sequences strings ;
   2 IN: vocabs.files
   3
   4 HELP: vocab-tests-path
   5 { $values { "vocab" "a vocabulary specifier" } { "path" "pathname string to test file" } }
   6 { $description "Outputs a pathname where the unit test file for " { $snippet "vocab" } " is located.  Outputs " { $link f } " if the vocabulary does not have a directory on disk." } ;
   7
   8 HELP: vocab-tests-file
   9 { $values { "vocab" "a vocabulary specifier" } { "path/f" "pathname string to test file" } }
  10 { $description "Outputs a pathname where the unit test file is located, or " { $link f } " if the file does not exist." } ;
  11
  12 HELP: vocab-tests-dir
  13 { $values { "vocab" "a vocabulary specifier" } { "paths" "a sequence of pathname strings" } }
  14 { $description "Outputs a sequence of pathnames for the tests in the test directory." } ;
  15
  16 HELP: vocab-files
  17 { $values { "vocab" "a vocabulary specifier" } { "seq" "a sequence of pathname strings" } }
  18 { $description "Outputs a sequence of files comprising this vocabulary, or " { $link f } " if the vocabulary does not have a directory on disk." }
  19 { $examples
  20   { $example
  21     "USING: prettyprint vocabs.files ; "
  22     "\"alien.libraries\" vocab-files ."
  23     $[
  24         {
  25             "{"
  26             "    \"resource:basis/alien/libraries/libraries.factor\""
  27             "    \"resource:basis/alien/libraries/libraries-docs.factor\""
  28             "    \"resource:basis/alien/libraries/libraries-tests.factor\""
  29             "}"
  30         } "\n" join
  31     ]
  32   }
  33 } ;
  34
  35 HELP: vocab-tests
  36 { $values { "vocab" "a vocabulary specifier" } { "tests" "a sequence of pathname strings" } }
  37 { $description "Outputs a sequence of pathnames where the unit tests for " { $snippet "vocab" } " are located." }
  38 { $examples
  39   { $example
  40     "USING: prettyprint vocabs.files ; "
  41     "\"xml\" vocab-tests ."
  42     $[
  43         {
  44             "{"
  45             "    \"resource:basis/xml/tests/xmode-dtd.factor\""
  46             "    \"resource:basis/xml/tests/test.factor\""
  47             "    \"resource:basis/xml/tests/state-parser-tests.factor\""
  48             "    \"resource:basis/xml/tests/soap.factor\""
  49             "    \"resource:basis/xml/tests/templating.factor\""
  50             "    \"resource:basis/xml/tests/encodings.factor\""
  51             "    \"resource:basis/xml/tests/xmltest.factor\""
  52             "    \"resource:basis/xml/tests/funny-dtd.factor\""
  53             "    \"resource:basis/xml/tests/cdata.factor\""
  54             "}"
  55         } "\n" join
  56     ]
  57   }
  58 } ;