pdm
/
pipewire-0
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Mistakes in docstrings corrected

This commit is contained in:
Milan Zamazal 2022-07-04 19:16:12 +02:00
parent 2b53b19c05
commit dd4c2728a5
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
pw-lib.el
View File

@ -120,7 +120,7 @@ A list of strings (possibly empty) is returned."
"Set the profile of the given device. "Set the profile of the given device.
DEVICE-ID is the numeric id of the device. DEVICE-ID is the numeric id of the device.
PROFILE is a string name of the profile, it must be one of the values PROFILE is a string name of the profile, it must be one of the values
returned from `pw-lib-profiles'. " returned from `pw-lib-profiles'."
(let* ((all-profiles (pw-access-profiles pw-lib--accessor device-id)) (let* ((all-profiles (pw-access-profiles pw-lib--accessor device-id))
(properties (cl-find profile all-profiles :key #'pw-lib--profile-name :test #'equal))) (properties (cl-find profile all-profiles :key #'pw-lib--profile-name :test #'equal)))
(unless properties (unless properties
@ -131,9 +131,9 @@ returned from `pw-lib-profiles'. "
(pw-access-set-profile pw-lib--accessor device-id index)))) (pw-access-set-profile pw-lib--accessor device-id index))))
(defun pw-lib-parent-node (object) (defun pw-lib-parent-node (object)
"Return parent node of `object'. "Return parent node of OBJECT.
This is typically used for ports. This is typically used for ports.
Behavior is undefined if `object' has no parent node." Behavior is undefined if OBJECT has no parent node."
(pw-lib-get-object (pw-lib-object-value object "node.id"))) (pw-lib-get-object (pw-lib-object-value object "node.id")))
(defun pw-lib--node (object) (defun pw-lib--node (object)
@ -251,7 +251,7 @@ version, call `pw-lib-refresh' first."
(list node-p parameters monitor-p node-id port-id))) (list node-p parameters monitor-p node-id port-id)))
(defun pw-lib-muted-p (object &optional refresh) (defun pw-lib-muted-p (object &optional refresh)
"Return whether the given PipeWire object is muted. "Return whether the given PipeWire OBJECT is muted.
Applicable only to Nodes and Ports. Applicable only to Nodes and Ports.
If REFRESH is non-nil then retrive fresh information from PipeWire If REFRESH is non-nil then retrive fresh information from PipeWire
rather than using cached data to obtain the result." rather than using cached data to obtain the result."
@ -274,7 +274,7 @@ rather than using cached data to obtain the result."
mute))) mute)))
(defun pw-lib-volume (object &optional refresh) (defun pw-lib-volume (object &optional refresh)
"Return volume of the given PipeWire object. "Return volume of the given PipeWire OBJECT.
The returned value is an integer in the range 0-100. The returned value is an integer in the range 0-100.
Applicable only to Nodes and Ports. Applicable only to Nodes and Ports.
If REFRESH is non-nil then retrive fresh information from PipeWire If REFRESH is non-nil then retrive fresh information from PipeWire