procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve process-get/process-put docstrings

Browse source 
* lisp/subr.el (process-get, process-put): Explain the purpose of these
functions in the docstring.
This commit is contained in:
Stefan Kangas 2025-03-01 02:01:30 +01:00
parent 73c646b777
commit 8b80401127
1 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
lisp/subr.el
View file

@ -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)))