[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/mpv 0e4318b45f 13/50: improve docstrings
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/mpv 0e4318b45f 13/50: improve docstrings |
Date: |
Tue, 28 Dec 2021 00:58:35 -0500 (EST) |
branch: elpa/mpv
commit 0e4318b45f42cd72613532b1121d8a28eaba8de4
Author: Johann Klähn <kljohann@gmail.com>
Commit: Johann Klähn <kljohann@gmail.com>
improve docstrings
---
mpv.el | 21 ++++++++++++++++++---
1 file changed, 18 insertions(+), 3 deletions(-)
diff --git a/mpv.el b/mpv.el
index 159d2743c6..514843d5d8 100644
--- a/mpv.el
+++ b/mpv.el
@@ -50,9 +50,14 @@
(defvar -queue nil)
(defun -alive-p ()
+ "Return non-nil if an mpv process is running."
(and -process (eq (process-status -process) 'run)))
(defun -start (&rest args)
+ "Start an mpv process with the specified ARGS.
+
+If there already is an mpv process controlled by this Emacs instance,
+it will be killed."
(kill)
(let ((socket (make-temp-name
(expand-file-name "mpv-" temporary-file-directory))))
@@ -84,6 +89,9 @@
(setq -queue nil))
(defun play (path)
+ "Start an mpv process playing the file at PATH.
+
+You can use this with `org-add-link-type' or `org-file-apps'."
(interactive "fFile: ")
(-start path))
@@ -91,7 +99,7 @@
"Add COMMAND to the transaction queue.
FN will be called with the corresponding answer.
-If DELAY-QUESTION is non-nil, delay sending this question until
+If DELAY-COMMAND is non-nil, delay sending this question until
the process has finished replying to any previous questions.
This produces more reliable results with some processes.
@@ -106,6 +114,13 @@ below."
t))
(defun -tq-filter (tq string)
+"Append to the queue's buffer and process the new data.
+
+TQ is a transaction queue created by `tq-create'.
+STRING is the data fragment received from the process.
+
+This is a verbatim copy of `tq-filter' that uses
+`mpv--tq-process-buffer' instead of `tq-process-buffer'."
(let ((buffer (tq-buffer tq)))
(when (buffer-live-p buffer)
(with-current-buffer buffer
@@ -144,7 +159,7 @@ drops unsolicited event messages."
(defun insert-playback-position (&optional arg)
"Insert the current playback position at point.
-When called with a prefix, insert a timer list item like `org-timer-item'."
+When called with a non-nil ARG, insert a timer list item like
`org-timer-item'."
(interactive "P")
(let ((buffer (current-buffer)))
(-enqueue '("get_property" "playback-time")
@@ -158,7 +173,7 @@ When called with a prefix, insert a timer list item like
`org-timer-item'."
`(0 ,secs ,usecs 0) t))))))))
(defun -position-insert-as-org-item (time-string)
- "Insert a description-type item with the playback position.
+ "Insert a description-type item with the playback position TIME-STRING.
See `org-timer-item' which this is based on."
(require 'org)
- [nongnu] elpa/mpv 15c51ddc5e 10/50: remove dependency on dash library, (continued)
- [nongnu] elpa/mpv 15c51ddc5e 10/50: remove dependency on dash library, ELPA Syncer, 2021/12/28
- [nongnu] elpa/mpv 059135de39 28/50: version 0.1.0, ELPA Syncer, 2021/12/28
- [nongnu] elpa/mpv 9e1781249f 27/50: convert numbers to strings before encoding as JSON, ELPA Syncer, 2021/12/28
- [nongnu] elpa/mpv 79e01bf89b 35/50: Remove stale socket files when mpv process is gone, ELPA Syncer, 2021/12/28
- [nongnu] elpa/mpv 4dddd55c5e 41/50: Add mpv-version., ELPA Syncer, 2021/12/28
- [nongnu] elpa/mpv 2d40c45505 38/50: Add mpv-seek and mpv-revert-seek commands, ELPA Syncer, 2021/12/28
- [nongnu] elpa/mpv a5c6eed9ac 44/50: Add volume control commands, ELPA Syncer, 2021/12/28
- [nongnu] elpa/mpv 3a43c9e60a 14/50: reorder function definitions, ELPA Syncer, 2021/12/28
- [nongnu] elpa/mpv 338af25d20 23/50: add mpv-on-event-hook, ELPA Syncer, 2021/12/28
- [nongnu] elpa/mpv 937bdf522a 17/50: implement seeking and changing of playback speed, ELPA Syncer, 2021/12/28
- [nongnu] elpa/mpv 0e4318b45f 13/50: improve docstrings,
ELPA Syncer <=
- [nongnu] elpa/mpv 0579b5c707 09/50: support inserting org timer list items, ELPA Syncer, 2021/12/28
- [nongnu] elpa/mpv ce3bbfac36 22/50: add mpv-default-options, ELPA Syncer, 2021/12/28
- [nongnu] elpa/mpv 9ef359d712 20/50: fix generation of autoloads, ELPA Syncer, 2021/12/28
- [nongnu] elpa/mpv 9ff4d5d80b 25/50: fix mpv-insert-playback-position, ELPA Syncer, 2021/12/28
- [nongnu] elpa/mpv 705e81b8a6 42/50: Make mpv-version more verbose and update its docstring as suggested, ELPA Syncer, 2021/12/28
- [nongnu] elpa/mpv ed83369372 39/50: Fix mpv-seek-to-position-at-point for start-of-playback position, ELPA Syncer, 2021/12/28
- [nongnu] elpa/mpv 2d24187f7b 43/50: Merge pull request #9 from firmart/patch-mpv-version, ELPA Syncer, 2021/12/28
- [nongnu] elpa/mpv ed9c7b0028 21/50: move functions to public interface, ELPA Syncer, 2021/12/28
- [nongnu] elpa/mpv ec4929ad5d 19/50: fix package header for melpa, ELPA Syncer, 2021/12/28
- [nongnu] elpa/mpv 9bd6d36cc7 50/50: Fix #16, ELPA Syncer, 2021/12/28