Fix incorrect docstring of mkdtemp!
authorMichael Gran <spk121@yahoo.com>
Tue, 19 Jan 2021 23:06:57 +0000 (15:06 -0800)
committerMichael Gran <spk121@yahoo.com>
Tue, 19 Jan 2021 23:06:57 +0000 (15:06 -0800)
* libguile/filesys.c (scm_mkdtemp_x): fix docstring

libguile/filesys.c

index 3cd3446c8cf4b96f594c77a9bfa8ceea70aa71e3..baff7b4c216e14f8ca5c204efff3dfd41ffe37ad 100644 (file)
@@ -1551,9 +1551,9 @@ SCM_DEFINE (scm_mkdtemp_x, "mkdtemp!", 1, 0, 0,
             "accordance with @var{tmpl}. The last 6 characters of the\n"
             "template must be XXXXXX\n"
             "\n"
-            "Upon success, the template string -- if mutable -- will be\n"
-            "modified in place with the name of the directory created.\n"
-            "The name will also be the return value.\n"
+            "Upon success, the template string, which must be mutable, will\n"
+            "be modified in place with the name of the directory created.\n"
+            "The return value is unspecified.\n"
             "\n"
             "An error may be thrown if the template is incorrect or if\n"
             "the directory could not be created.\n")