From: Stefan Kangas <stefankangas@gmail.com>
Date: Sat, 1 Mar 2025 01:01:30 +0000 (+0100)
Subject: Improve process-get/process-put docstrings
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=06d42a5594b9f936e8529d3fac7db953b82f72b1;p=emacs.git

Improve process-get/process-put docstrings

* lisp/subr.el (process-get, process-put): Explain the purpose of these
functions in the docstring.

(cherry picked from commit 8b804011275f9f7b5dda1f03e1d6118cae2846c5)
---

diff --git a/lisp/subr.el b/lisp/subr.el
index af2ffa713e5..a9765f179b2 100644
--- a/lisp/subr.el
+++ b/lisp/subr.el
@@ -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)))