From 77ddcbe12e169051f9bad1ab5e7581b148a94883 Mon Sep 17 00:00:00 2001
From: Robert Hensing <roberth@users.noreply.github.com>
Date: Mon, 26 Aug 2024 16:15:13 +0200
Subject: [PATCH] getDoc: Explain why we partially apply __functor

---
 src/libexpr/eval.cc | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/libexpr/eval.cc b/src/libexpr/eval.cc
index b87d96be0..ca41a9944 100644
--- a/src/libexpr/eval.cc
+++ b/src/libexpr/eval.cc
@@ -621,6 +621,11 @@ std::optional<EvalState::Doc> EvalState::getDoc(Value & v)
             Value & functor = *v.attrs()->find(sFunctor)->value;
             Value * vp = &v;
             Value partiallyApplied;
+            // The first paramater is not user-provided, and may be
+            // handled by code that is opaque to the user, like lib.const = x: y: y;
+            // So preferably we show docs that are relevant to the
+            // "partially applied" function returned by e.g. `const`.
+            // We apply the first argument:
             callFunction(functor, 1, &vp, partiallyApplied, noPos);
             auto _level = addCallDepth(noPos);
             return getDoc(partiallyApplied);