diff options
| author | Stefan Kangas <stefankangas@gmail.com> | 2025-03-01 02:01:30 +0100 |
|---|---|---|
| committer | Stefan Kangas <stefankangas@gmail.com> | 2025-03-01 06:36:43 +0100 |
| commit | 8b804011275f9f7b5dda1f03e1d6118cae2846c5 (patch) | |
| tree | 13632be45f981c59b607e0883bdc925ac0e5b6b5 /lisp/subr.el | |
| parent | 73c646b7771bc81e622933443b5b336d40f8d8c2 (diff) | |
| download | emacs-8b804011275f9f7b5dda1f03e1d6118cae2846c5.tar.gz emacs-8b804011275f9f7b5dda1f03e1d6118cae2846c5.tar.bz2 emacs-8b804011275f9f7b5dda1f03e1d6118cae2846c5.zip | |
Improve process-get/process-put docstrings
* lisp/subr.el (process-get, process-put): Explain the purpose of these
functions in the docstring.
Diffstat (limited to 'lisp/subr.el')
| -rw-r--r-- | lisp/subr.el | 10 |
1 files changed, 8 insertions, 2 deletions
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))) |