branch: externals/dtache
commit 6f45c07a20bf455766770a1e7a267f6e2a711c45
Author: Niklas Eklund <niklas.ekl...@posteo.net>
Commit: Niklas Eklund <niklas.ekl...@posteo.net>
Fix checkdoc and package-lint violations
---
dtache-compile.el | 2 +-
dtache-eshell.el | 2 +-
dtache.el | 19 +++++++++----------
3 files changed, 11 insertions(+), 12 deletions(-)
diff --git a/dtache-compile.el b/dtache-compile.el
index 96463b75bd..264c4372f5 100644
--- a/dtache-compile.el
+++ b/dtache-compile.el
@@ -111,7 +111,7 @@ Optionally EDIT-COMMAND."
(apply compilation-start args)))
(defun dtache-compile--start (_)
- "Run in `compilation-start-hook' if dtache-enabled."
+ "Run in `compilation-start-hook' if `dtache-enabled'."
(when dtache-enabled
(setq dtache--buffer-session dtache--current-session)
(dtache-compile--replace-modesetter)
diff --git a/dtache-eshell.el b/dtache-eshell.el
index 95b5d8ae01..ec50b3666d 100644
--- a/dtache-eshell.el
+++ b/dtache-eshell.el
@@ -123,7 +123,7 @@ If prefix-argument directly DETACH from the session."
;;;###autoload
(define-minor-mode dtache-eshell-mode
- "Integrate `dtache' in eshell-mode."
+ "Integrate `dtache' in `eshell-mode'."
:lighter "dtache-eshell"
:keymap (let ((map (make-sparse-keymap)))
map)
diff --git a/dtache.el b/dtache.el
index d25b166979..398bb16bc0 100644
--- a/dtache.el
+++ b/dtache.el
@@ -120,8 +120,7 @@
:group 'dtache)
(defcustom dtache-notification-function #'dtache-state-transition-notification
- "Variable to set which function to use to issue a notification when
-a session transitions from active to inactive."
+ "Variable to set which function to use to issue a notification."
:type 'function
:group 'dtache)
@@ -306,7 +305,7 @@ Optionally SUPPRESS-OUTPUT."
;;;###autoload
(defun dtache-rerun-session (session &optional suppress-output)
- "Rerun SESSION."
+ "Rerun SESSION, optionally SUPPRESS-OUTPUT."
(interactive
(list (dtache-completing-read (dtache-get-sessions))
current-prefix-arg))
@@ -453,8 +452,8 @@ Optionally SUPPRESS-OUTPUT."
"Detach from current session.
This command is only activated if `dtache--buffer-session' is set and
-`dtache--determine-session-state' returns active. For modes such as
-compilation or shell-command the command will also kill the window."
+`dtache--determine-session-state' returns active. For modes such as
+compilation or `shell-command' the command will also kill the window."
(interactive)
(if (dtache-session-p dtache--buffer-session)
(if-let ((command-or-compile
@@ -807,7 +806,7 @@ Optionally CONCAT the command return command into a string."
(defun dtache--session-timer-monitor (session)
"Configure a timer to monitor SESSION activity.
- The timer object is configured according to `dtache-timer-configuration'."
+The timer object is configured according to `dtache-timer-configuration'."
(with-connection-local-variables
(let* ((timer)
(callback
@@ -1021,7 +1020,7 @@ Optionally make the path LOCAL to host."
('create "-n")
('create-and-attach "-c")
('attach "-a")
- (_ (error "`dtache-session-mode' has an unknown value."))))
+ (_ (error "`dtache-session-mode' has an unknown value"))))
(defun dtache--session-state-transition-update (session)
"Update SESSION due to state transition."
@@ -1085,8 +1084,8 @@ If SESSION is nonattachable fallback to a command that
doesn't rely on tee."
(defun dtache--determine-duration (session &optional approximate)
"Return the time duration of the SESSION.
-Modification time is not reliable whilst a session is active. Instead
-the current time is used."
+If APPROXIMATE, use latest modification time to deduce the duration.
+Otherwise the current time is used."
(if (not approximate)
(- (time-to-seconds) (dtache--session-creation-time session))
(- (time-to-seconds
@@ -1182,7 +1181,7 @@ the current time is used."
;;;###autoload
(define-minor-mode dtache-shell-mode
- "Integrate `dtache' in shell-mode."
+ "Integrate `dtache' in `shell-mode'."
:lighter "dtache-shell"
:keymap (let ((map (make-sparse-keymap)))
map)
