aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHugo Hörnquist <hugo@lysator.liu.se>2023-04-10 21:57:18 +0200
committerHugo Hörnquist <hugo@lysator.liu.se>2023-04-10 23:45:29 +0200
commit5e37b67067252cfdd4440b28f7992f7051748fd5 (patch)
treecab769c2324b85853710071fb2f57eda8e22d743
parentReorder (util .*) tests. (diff)
downloadcalp-5e37b67067252cfdd4440b28f7992f7051748fd5.tar.gz
calp-5e37b67067252cfdd4440b28f7992f7051748fd5.tar.xz
Minor touchup of (hnh util) documentation.
-rw-r--r--doc/ref/guile/util-path.texi8
-rw-r--r--doc/ref/guile/util.texi7
2 files changed, 12 insertions, 3 deletions
diff --git a/doc/ref/guile/util-path.texi b/doc/ref/guile/util-path.texi
index cf99a170..9cf41b40 100644
--- a/doc/ref/guile/util-path.texi
+++ b/doc/ref/guile/util-path.texi
@@ -36,7 +36,13 @@ The first component will be @code{""} if path is absolute.
@defun filename-extension filename
-Returns the extension of the filename, or the empty string if none exists.
+Returns the extension of the filename without a leading period, or the
+empty string if none exists.
+
+@example
+(filename-extension "file.tar.gz")
+⇒ "gz"
+@end example
@end defun
@defun realpath path
diff --git a/doc/ref/guile/util.texi b/doc/ref/guile/util.texi
index 1b4228cd..32e7543f 100644
--- a/doc/ref/guile/util.texi
+++ b/doc/ref/guile/util.texi
@@ -221,7 +221,9 @@ list, whose indices matches the order of the inputs
@end defun
@defun string-flatten tree
-@c TODO document me
+Given an arbitary tree, do a pre-order traversal, appending all strings.
+
+Non-strings are converted to strings, and also appended.
@end defun
@defun intersperse item list
@@ -229,7 +231,7 @@ Inserts @var{item} between each element in @var{list}.
@end defun
-@defun insert-ordered item collection [<=<]
+@defun insert-ordered item collection [<]
Inserts @var{item} into @var{collection}, such that collection
remainins sorted if it was sorted beforehand.
@end defun
@@ -365,6 +367,7 @@ the file, and @code{#f} otherwise.
@defun call-with-tmpfile proc [#:tmpl ``/tmp/file-XXXXXXX'']
@end defun
+@c Is this even a procedure?
@defun read-file path
Open file at path, and return its content as a string.
@end defun