]> git.eshelyaron.com Git - emacs.git/commitdiff
Improve process-get/process-put docstrings
authorStefan Kangas <stefankangas@gmail.com>
Sat, 1 Mar 2025 01:01:30 +0000 (02:01 +0100)
committerEshel Yaron <me@eshelyaron.com>
Tue, 4 Mar 2025 20:56:35 +0000 (21:56 +0100)
* lisp/subr.el (process-get, process-put): Explain the purpose of these
functions in the docstring.

(cherry picked from commit 8b804011275f9f7b5dda1f03e1d6118cae2846c5)

lisp/subr.el

index af2ffa713e554d174caeb6f321cc4af521334825..a9765f179b213555c51463708123c1227e285139 100644 (file)
@@ -3348,13 +3348,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)))