From 8b804011275f9f7b5dda1f03e1d6118cae2846c5 Mon Sep 17 00:00:00 2001 From: Stefan Kangas Date: Sat, 1 Mar 2025 02:01:30 +0100 Subject: Improve process-get/process-put docstrings * lisp/subr.el (process-get, process-put): Explain the purpose of these functions in the docstring. --- lisp/subr.el | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) (limited to 'lisp/subr.el') diff --git a/lisp/subr.el b/lisp/subr.el index dfd91825363..37a3f9efe6b 100644 --- a/lisp/subr.el +++ b/lisp/subr.el @@ -3263,13 +3263,19 @@ process." (defun process-get (process propname) "Return the value of PROCESS' PROPNAME property. -This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'." +This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'. + +Together with `process-put', this can be used to store and retrieve +miscellaneous values associated with the process." (declare (side-effect-free t)) (plist-get (process-plist process) propname)) (defun process-put (process propname value) "Change PROCESS' PROPNAME property to VALUE. -It can be retrieved with `(process-get PROCESS PROPNAME)'." +It can be retrieved with `(process-get PROCESS PROPNAME)'. + +Together with `process-get', this can be used to store and retrieve +miscellaneous values associated with the process." (set-process-plist process (plist-put (process-plist process) propname value))) -- cgit v1.2.3