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

io.files.unique: Better docs for with-unique-directory.

db4
Doug Coleman 2015-06-01 15:22:05 -07:00
parent 51d60dd833
commit 2ee3516bf1
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
basis/io/files/unique/unique-docs.factor
View File

@ -1,4 +1,4 @@
USING: help.markup help.syntax quotations strings ;
USING: help.markup help.syntax io.directories quotations strings ;
IN: io.files.unique
HELP: default-temporary-directory
@ -37,8 +37,8 @@ HELP: cleanup-unique-file
HELP: unique-directory
{ $values { "path" "a pathname string" } }
{ $description "Creates a directory in the value in " { $link current-temporary-directory } " that is guaranteed not to exist in and returns the full pathname." }
{ $errors "Throws an error if the directory cannot be created after a number of tries. The most likely error is incorrect directory permissions on the temporary directory." } ;
{ $description "Creates a directory in " { $link current-temporary-directory } " that is guaranteed not to exist and return the full pathname. The mechanism for the guarantee of uniqueness is retrying with a randomly generated filename until " { $link make-directory } " does not fail." }
{ $errors "Throws an error if the directory cannot be created after a number of tries " { $link unique-retries } ". The most likely error is incorrect directory permissions on the temporary directory." } ;
HELP: cleanup-unique-directory
{ $values { "quot" quotation } }