]> gitweb.factorcode.org Git - factor.git/commitdiff
io.files.info docs, sync link-info and file-info docs
authorJon Harper <jon.harper87@gmail.com>
Wed, 22 Jun 2016 18:11:29 +0000 (20:11 +0200)
committerJohn Benediktsson <mrjbq7@gmail.com>
Wed, 22 Jun 2016 18:22:43 +0000 (11:22 -0700)
basis/io/files/info/info-docs.factor

index 8d0b6c52b34b0c9ed131cafc492a6fc11dde8b67..87ca59b3c8746f88502d14e1d537263dd2944776 100644 (file)
@@ -7,8 +7,9 @@ HELP: file-info
 { $errors "Throws an error if the file does not exist." } ;
 
 HELP: link-info
-{ $values { "path" "a pathname string" } { "info" "a file-info tuple" } }
-{ $description "Queries the file system for metadata. If path refers to a symbolic link, information about the symbolic link itself is returned. If the file does not exist, an exception is thrown." } ;
+{ $values { "path" "a pathname string" } { "info" file-info-tuple } }
+{ $description "Queries the file system for metadata. If " { $snippet "path" } " refers to a symbolic link, information about the symbolic link itself is returned.  See the article " { $link "file-types" } " for a list of metadata symbols." }
+{ $errors "Throws an error if the file does not exist." } ;
 
 { file-info link-info } related-words