diff --git a/smudge-api.el b/smudge-api.el index 08ee9c9..21af503 100644 --- a/smudge-api.el +++ b/smudge-api.el @@ -598,7 +598,7 @@ Call CALLBACK if provided." (defun smudge-api-queue-add-track (track-id &optional callback) - "Add given TRACK-ID to the queue" + "Add given TRACK-ID to the queue and call CALLBACK afterwards." (smudge-api-call-async "POST" (concat "/me/player/queue?" @@ -608,7 +608,7 @@ Call CALLBACK if provided." callback)) (defun smudge-api-queue-add-tracks (track-ids &optional callback) - "Add given TRACK-IDS to the queue" + "Add given TRACK-IDS to the queue and call CALLBACK afterwards." ;; Spotify's API doesn't provide a endpoint that would enable us to ;; add multiple tracks to the queue at the same time. ;; Thus we have to synchronously add the tracks diff --git a/smudge-connect.el b/smudge-connect.el index d66a904..ca6620b 100644 --- a/smudge-connect.el +++ b/smudge-connect.el @@ -118,7 +118,7 @@ Returns a JSON string in the format: (message "Volume decreased to %d%%" new-volume)))))))) (defun smudge-connect-volume-mute-unmute () - "Mute/unmute the volume on the actively playing device by setting the volume to 0." + "Mute/unmute the actively playing device by setting the volume to 0." (smudge-connect-when-device-active (smudge-api-get-player-status (lambda (status) diff --git a/smudge-controller.el b/smudge-controller.el index 1eb78b9..b508d57 100644 --- a/smudge-controller.el +++ b/smudge-controller.el @@ -15,7 +15,8 @@ (require 'smudge-api) (defmacro smudge-if-gnu-linux (then else) - "Evaluate THEN form if Emacs is running in GNU/Linux, otherwise evaluate ELSE form." + "Evaluate THEN form if Emacs is running in GNU/Linux, otherwise evaluate +ELSE form." `(if (eq system-type 'gnu/linux) ,then ,else)) (defmacro smudge-when-gnu-linux (then) @@ -32,7 +33,7 @@ (defcustom smudge-transport 'connect "How the commands should be sent to Spotify process. -Defaults to 'connect, as it provides a consistent UX across all OSes." +Defaults to \\='connect, as it provides a consistent UX across all OSes." :type '(choice (symbol :tag "AppleScript" apple) (symbol :tag "D-Bus" dbus) (symbol :tag "Connect" connect)) @@ -94,7 +95,7 @@ The following placeholders are supported: * %t - Track name (truncated) * %n - Track # * %l - Track duration, in minutes (i.e. 01:35) -* %p - Player status indicator for 'playing', 'paused', and 'stopped' states +* %p - Player status indicator for playing, paused, and stopped states * %s - Player shuffling status indicator * %r - Player repeating status indicator" :type 'string @@ -117,7 +118,8 @@ Apply SUFFIX to smudge-controller-prefixed functions, applying ARGS." (run-at-time 1 nil #'smudge-controller-player-status)))) (defun smudge-controller-update-metadata (metadata) - "Compose the playing status string to be displayed in the mode-line from METADATA." + "Compose the playing status string to be displayed in the mode-line +from METADATA." (let* ((player-status smudge-player-status-format) (duration-format "%m:%02s") (json-object-type 'hash-table) @@ -169,7 +171,8 @@ This corresponds to the current REPEATING state." (and (boundp 'smudge-controller-timer) (timerp smudge-controller-timer))) (defun smudge-controller-start-player-status-timer () - "Start the timer that will update the mode line according to the Spotify player status." + "Start the timer that will update the mode line according to the Spotify +player status." (when (and (not (smudge-controller-timerp)) (> smudge-player-status-refresh-interval 0)) (setq smudge-controller-timer (run-at-time t smudge-player-status-refresh-interval #'smudge-controller-player-status)))) diff --git a/smudge-remote.el b/smudge-remote.el index c0f09c9..e32499b 100644 --- a/smudge-remote.el +++ b/smudge-remote.el @@ -21,7 +21,7 @@ :type 'string) (defcustom smudge-status-location 'modeline - "Specify where to show the player status: one of '(modeline title-bar nil)." + "Specify where to show the player status: one of \\='(modeline title-bar nil)." :type '(choice (const :tag "Modeline" modeline) (const :tag "Title Bar" title-bar) (const :tag "Do not show" nil)) diff --git a/smudge-track.el b/smudge-track.el index ad419f6..66d4c8f 100644 --- a/smudge-track.el +++ b/smudge-track.el @@ -294,7 +294,7 @@ Default to sortin tracks by number when listing the tracks from an album." (smudge-api-queue-add-track track-id (lambda(_) - (message (format "Added \"%s\" to your queue." (smudge-api-get-item-name selected-track)))))))) + (message "Added \"%s\" to your queue." (smudge-api-get-item-name selected-track))))))) (provide 'smudge-track) diff --git a/smudge.el b/smudge.el index 3097180..d0ea6af 100644 --- a/smudge.el +++ b/smudge.el @@ -153,7 +153,7 @@ Prompt for the NAME and whether it should be made PUBLIC." (define-key map (kbd "t s") #'smudge-track-search) (define-key map (kbd "d") #'smudge-select-device) map) - "Keymap for Spotify commands after 'smudge-keymap-prefix'.") + "Keymap for Spotify commands after \\='smudge-keymap-prefix\\='.") (fset 'smudge-command-map smudge-command-map) (easy-menu-add-item nil '("Tools")