aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArun Isaac2024-09-11 16:00:16 +0100
committerArun Isaac2024-09-11 16:00:16 +0100
commitdcb1939e6deff6134686f9ae422389b630a1a4ad (patch)
tree96f44e6378f51a8dc4d99701b93baa2e8a6f0264
parent7ee4844373b31c43eb1d1a2cbf46edfab0b7a71b (diff)
downloadravanan-dcb1939e6deff6134686f9ae422389b630a1a4ad.tar.gz
ravanan-dcb1939e6deff6134686f9ae422389b630a1a4ad.tar.lz
ravanan-dcb1939e6deff6134686f9ae422389b630a1a4ad.zip
ui: Add docstrings.
* ravanan/ui.scm (warning, user-error): Add docstrings.
-rw-r--r--ravanan/ui.scm3
1 files changed, 3 insertions, 0 deletions
diff --git a/ravanan/ui.scm b/ravanan/ui.scm
index f8355b2..e7ca95c 100644
--- a/ravanan/ui.scm
+++ b/ravanan/ui.scm
@@ -21,9 +21,12 @@
user-error))
(define (warning fmt . args)
+ "Print warning. @var{fmt} and @var{args} are arguments to format."
(apply format (current-error-port) fmt args)
(newline))
(define (user-error fmt . args)
+ "Print error message and exit with failure. @var{fmt} and @var{args} are
+arguments to format."
(apply warning fmt args)
(exit #f))