]> gitweb.factorcode.org Git - factor.git/commitdiff
Docs: examples for vocab-files and vocab-tests
authorBjörn Lindqvist <bjourne@gmail.com>
Mon, 6 Jan 2014 07:33:50 +0000 (08:33 +0100)
committerJohn Benediktsson <mrjbq7@gmail.com>
Mon, 14 Apr 2014 15:42:09 +0000 (08:42 -0700)
basis/vocabs/files/files-docs.factor

index 2f0ea76bdc121fa7a5a832d0514007e165276a22..0cf6880bec813f8bbbecc4817de0b33b8d18b31d 100644 (file)
@@ -15,9 +15,35 @@ HELP: vocab-tests-dir
 
 HELP: vocab-files
 { $values { "vocab" "a vocabulary specifier" } { "seq" "a sequence of pathname strings" } }
-{ $description "Outputs a sequence of files comprising this vocabulary, or " { $link f } " if the vocabulary does not have a directory on disk." } ;
+{ $description "Outputs a sequence of files comprising this vocabulary, or " { $link f } " if the vocabulary does not have a directory on disk." }
+{ $examples
+  { $example
+    "USING: vocabs.files ; "
+    "\"alien.libraries\" vocab-files ."
+    "{"
+    "    \"resource:basis/alien/libraries/libraries.factor\""
+    "    \"resource:basis/alien/libraries/libraries-docs.factor\""
+    "    \"resource:basis/alien/libraries/libraries-tests.factor\""
+    "}"
+  }
+} ;
 
 HELP: vocab-tests
 { $values { "vocab" "a vocabulary specifier" } { "tests" "a sequence of pathname strings" } }
-{ $description "Outputs a sequence of pathnames where the unit tests for " { $snippet "vocab" } " are located." } ;
-
+{ $description "Outputs a sequence of pathnames where the unit tests for " { $snippet "vocab" } " are located." }
+{ $examples
+  { $example
+    "USING: vocabs.files ; "
+    "\"xml\" vocab-tests ."
+    "{"
+    "    \"resource:basis/xml/tests/xmode-dtd.factor\""
+    "    \"resource:basis/xml/tests/test.factor\""
+    "    \"resource:basis/xml/tests/state-parser-tests.factor\""
+    "    \"resource:basis/xml/tests/soap.factor\""
+    "    \"resource:basis/xml/tests/templating.factor\""
+    "    \"resource:basis/xml/tests/encodings.factor\""
+    "    \"resource:basis/xml/tests/xmltest.factor\""
+    "    \"resource:basis/xml/tests/funny-dtd.factor\""
+    "}"
+  }
+} ;