From 51d88440c9ac53e85195c128a624be0c81521983 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Hugo=20H=C3=B6rnquist?= <hugo@lysator.liu.se>
Date: Sat, 25 Apr 2020 14:40:03 +0200
Subject: Document 'warning'

---
 module/util/exceptions.scm | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/module/util/exceptions.scm b/module/util/exceptions.scm
index 6b45e14d..09bd3f97 100644
--- a/module/util/exceptions.scm
+++ b/module/util/exceptions.scm
@@ -47,5 +47,7 @@
              "WARNING: ~?~%" fmt args))))
 
 
+;; forwards return from warning-hander. By default returns an unspecified value,
+;; but instances are free to provide a proper return value and use it.
 (define-public (warning fmt . args)
   (apply (warning-handler) fmt (or args '())))
-- 
cgit v1.2.3