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

Mistakes in docstrings corrected

Browse Source
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

8
pw-lib.el
View File

@ -131,9 +131,9 @@ returned from `pw-lib-profiles'. "
(pw-access-set-profile pw-lib--accessor device-id index))))
(defun pw-lib-parent-node (object)
"Return parent node of `object'.
"Return parent node of OBJECT.
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")))
(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)))
(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.
If REFRESH is non-nil then retrive fresh information from PipeWire
rather than using cached data to obtain the result."
@ -274,7 +274,7 @@ rather than using cached data to obtain the result."
mute)))
(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.
Applicable only to Nodes and Ports.
If REFRESH is non-nil then retrive fresh information from PipeWire