branch: elpa/subed
commit 73d303d3b043fbcb65fcd4f25126f6e5fef51e15
Author: Random User <rnd...@posteo.de>
Commit: Random User <rnd...@posteo.de>
Adjust some docstrings
---
subed/subed-srt.el | 14 ++++++--------
subed/subed.el | 4 ++--
2 files changed, 8 insertions(+), 10 deletions(-)
diff --git a/subed/subed-srt.el b/subed/subed-srt.el
index fe222c9..47ec9ff 100644
--- a/subed/subed-srt.el
+++ b/subed/subed-srt.el
@@ -321,20 +321,18 @@ Return point or nil if there is no previous subtitle."
(defun subed-srt-increase-start-time (&optional arg)
"Add `subed-seconds-adjust' milliseconds to start time of current subtitle.
-`subed-seconds-adjust' is set to the value of a numerical prefix
-argument if provided. If the prefix argument is not numerical,
-`subed-seconds-adjust' is reset to it's default value.
+The first step is to set `subed-seconds-adjust' to the value of
+the prefix argument if it is provided and if it is a number. If
+the prefix argument is provided but not numerical,
+`subed-seconds-adjust' is reset to its default value.
Example usage:
\\[universal-argument] 1000 \\[subed-increase-start-time] Increase start
time by 1000ms
\\[subed-increase-start-time] Increase start time by 1000ms again
- [...] [...]
\\[universal-argument] 500 \\[subed-increase-start-time] Increase start
time by 500ms
\\[subed-increase-start-time] Increase start time by 500ms again
- [...] [...]
- \\[universal-argument] \\[subed-increase-start-time] Increase start
time by 100ms
- \\[subed-increase-start-time] Increase start time by 100ms again
- [...] [...]"
+ \\[universal-argument] \\[subed-increase-start-time] Increase start
time by 100ms (the default)
+ \\[subed-increase-start-time] Increase start time by 100ms (the
default) again"
(interactive "P")
(subed-srt--adjust-subtitle-start-relative (subed--get-seconds-adjust arg)))
diff --git a/subed/subed.el b/subed/subed.el
index 86e26f3..adf490a 100644
--- a/subed/subed.el
+++ b/subed/subed.el
@@ -357,8 +357,8 @@ buffer."
(defmacro subed--save-excursion (&rest body)
"Restore relative point within current subtitle after executing BODY.
-This also works if the buffer changes as long the subtitle IDs
-don't change."
+This also works if the buffer changes (e.g. when sorting
+subtitles) as long the subtitle IDs don't change."
(save-excursion
`(let ((sub-id (subed--subtitle-id))
(sub-pos (subed--subtitle-relative-point)))
