branch: externals/llm
commit 650bba65d5c25d66be9fb932c0818f3a8d65ef12
Author: Andrew Hyatt <ahy...@gmail.com>
Commit: Andrew Hyatt <ahy...@gmail.com>
Improve the docstring for llm--warn-on-nonfree
---
llm.el | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/llm.el b/llm.el
index 6c96aba4a2..5d6202b18b 100644
--- a/llm.el
+++ b/llm.el
@@ -49,7 +49,13 @@
:type 'boolean)
(defun llm--warn-on-nonfree (name tos)
- "Issue a warning if `llm-warn-on-nonfree' is non-nil."
+ "Issue a warning if `llm-warn-on-nonfree' is non-nil.
+NAME is the human readable name of the LLM (e.g 'Open AI').
+
+TOS is the URL of the terms of service for the LLM.
+
+All non-free LLMs should call this function on each llm function
+invocation."
(when llm-warn-on-nonfree
(lwarn '(llm nonfree) :warning "%s API is not free software, and your
freedom to use it is restricted.
See %s for the details on the restrictions on use." name tos)))
