branch: externals/listen
commit 698b51f459e3bbe5d2ec6621d6183afaa787f8c5
Author: Adam Porter <[email protected]>
Commit: Adam Porter <[email protected]>
Tidy: Docstrings
---
listen-info.el | 6 +++---
listen-lib.el | 6 ++++--
2 files changed, 7 insertions(+), 5 deletions(-)
diff --git a/listen-info.el b/listen-info.el
index c149987522..1d78d10058 100644
--- a/listen-info.el
+++ b/listen-info.el
@@ -826,9 +826,9 @@ If there is no such identifier, return nil."
(defun listen-info--read-id3v2-frame-data (filename begin num-bytes unsync)
"Read NUM-BYTES of raw id3v2 frame data from FILENAME.
-Start reading from offset BEGIN. If UNSYNC is t, all 'FF 00'
-byte combinations are replaced by 'FF'. Replaced byte pairs are
-counted as one, instead of two, towards NUM-BYTES.
+Start reading from offset BEGIN. If UNSYNC is t, all \"FF 00\" byte
+combinations are replaced by \"FF\". Replaced byte pairs are counted as
+one, instead of two, towards NUM-BYTES.
Return a cons cell (OFFSET . DATA), where OFFSET is the byte
offset after NUM-BYTES bytes have been read, and DATA is the raw
diff --git a/listen-lib.el b/listen-lib.el
index 95319ef928..49f952cabf 100644
--- a/listen-lib.el
+++ b/listen-lib.el
@@ -107,7 +107,8 @@ keywords are supported:
;; TODO: Add queue slot.
process command args
(status
- nil :documentation "Symbol representing player's playback status (e.g.
`playing', `paused', `stopped', or nil if unknown).")
+ nil :documentation "Symbol representing player's playback status.
+For example, `playing', `paused', `stopped', or nil if unknown.")
(etc nil :documentation "Alist used to store other information about the
player.")
(path nil :documentation "Filename path or URL to currently playing track,
if any.")
(metadata nil :documentation "Metadata alist.")
@@ -117,7 +118,8 @@ keywords are supported:
(playback-started-at
nil :documentation "Time at which playback started (used to compute
elapsed/remaining).")
(playback-started-from
- nil :documentation "Track position at which playback last started/unpaused,
in seconds (used to compute elapsed/remaining).")
+ nil :documentation "Track position at which playback last started/unpaused,
in seconds.
+Used to compute elapsed/remaining.")
(duration
nil :documentation "Duration of current track, in seconds (used to compute
elapsed/remaining)."))
