From: Mark Wooding <mdw@distorted.org.uk>
Date: Sat, 30 Jun 2018 20:37:07 +0000 (+0100)
Subject: dep.lisp (%dep-value): Document why this is a separate function.
X-Git-Url: https://git.distorted.org.uk/~mdw/lisp/commitdiff_plain/b59116d4852b98693178ff0d98b99dc690514c69

dep.lisp (%dep-value): Document why this is a separate function.

I almost committed a change which folded this into `dep-value' before
noticing that the latter is marked `inline'.
---

diff --git a/dep.lisp b/dep.lisp
index 3a1520f..ecd1628 100644
--- a/dep.lisp
+++ b/dep.lisp
@@ -228,7 +228,9 @@
 	       (progn (setf (dep-flags dep) flags) nil))))))
 
 (defun %dep-value (dep)
-  "Do the difficult work of retrieving the current value of a DEP."
+  "Do the difficult work of retrieving the current value of a DEP.
+
+   This is the unhappy path of `dep-value'."
   (force-dep-value dep)
   (when *evaluating-dep*
     (pushnew (dep-weak-pointer *evaluating-dep*) (dep-dependents dep))