environment: update docs for with-os-env.

[factor.git] / basis / environment / environment-docs.factor

diff --git a/basis/environment/environment-docs.factor b/basis/environment/environment-docs.factor
index 8e5ef8b352f21f6e087516e09abb2fd055d87c4f..6129b07302e1a19f5421feedb0dcdf81bd00e558 100644 (file)
--- a/basis/environment/environment-docs.factor
+++ b/basis/environment/environment-docs.factor
@@ -81,7 +81,11 @@ HELP: unset-os-env
     "Names and values of environment variables are operating system-specific."
 } ;
 
-{ os-env os-envs set-os-env unset-os-env set-os-envs set-os-envs-pointer change-os-env } related-words
+HELP: with-os-env
+{ $values { "value" string } { "key" string } { "quot" "quotation" } }
+{ $description "Calls a quotation with the " { $snippet "key" } " environment variable set to " { $snippet "value" } ", resetting the environment variable afterwards to its previous value." } ;
+
+{ os-env os-envs set-os-env unset-os-env set-os-envs set-os-envs-pointer change-os-env with-os-env } related-words
 
 
 ARTICLE: "environment" "Environment variables"