From 2ee3516bf100a37a22c0ecfbeb25b088d9a2e493 Mon Sep 17 00:00:00 2001 From: Doug Coleman Date: Mon, 1 Jun 2015 15:22:05 -0700 Subject: [PATCH] io.files.unique: Better docs for with-unique-directory. --- basis/io/files/unique/unique-docs.factor | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/basis/io/files/unique/unique-docs.factor b/basis/io/files/unique/unique-docs.factor index 0dc85d6b04..0e58900788 100644 --- a/basis/io/files/unique/unique-docs.factor +++ b/basis/io/files/unique/unique-docs.factor @@ -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 } }