steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Minor documentation fixes.

db4
Alexander Iljin 2015-09-16 18:09:03 +03:00 committed by John Benediktsson
parent 2dea9bab74
commit 156a2d0b90
2 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
basis/io/files/info/info-docs.factor
View File

@ -2,7 +2,7 @@ USING: arrays help.markup help.syntax kernel io.files ;
IN: io.files.info IN: io.files.info
HELP: file-info HELP: file-info
{ $values { "path" "a pathname string" } { "info" file-info } } { $values { "path" "a pathname string" } { "info" file-info-tuple } }
{ $description "Queries the file system for metadata. If " { $snippet "path" } " refers to a symbolic link, it is followed. See the article " { $link "file-types" } " for a list of metadata symbols." } { $description "Queries the file system for metadata. If " { $snippet "path" } " refers to a symbolic link, it is followed. See the article " { $link "file-types" } " for a list of metadata symbols." }
{ $errors "Throws an error if the file does not exist." } ; { $errors "Throws an error if the file does not exist." } ;
@ -31,7 +31,7 @@ HELP: file-systems
HELP: file-system-info HELP: file-system-info
{ $values { $values
{ "path" "a pathname string" } { "path" "a pathname string" }
{ "file-system-info" file-system-info } } { "file-system-info" file-system-info-tuple } }
{ $description "Returns a platform-specific object describing the file-system that contains the path. The cross-platform slot is " { $slot "free-space" } "." } { $description "Returns a platform-specific object describing the file-system that contains the path. The cross-platform slot is " { $slot "free-space" } "." }
{ $examples { $examples
{ $unchecked-example { $unchecked-example