chore: Fix documentation issues reported by 'eldev lint'.

szermatt · Oct 11, 2024 · 6d2d779 · 6d2d779
1 parent d33d86f
commit 6d2d779
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 3 deletions.
diff --git a/mistty-term.el b/mistty-term.el
@@ -728,7 +728,8 @@ If N is specified, the string is repeated N times."
   "TRAMP-aware alternative to `term-command-hook'.
 
 This function is meant to be bound to `term-command-function' to
-catch Emacs-specific control sequences \\032...\n.
+catch Emacs-specific control sequences \\032...\\n. The STRING
+argument includes everything between \\032 and \\n.
 
 When `default-directory' is remote, this function interprets paths
 sent by the terminal as being local to the TRAMP connection. The

diff --git a/mistty-util.el b/mistty-util.el
@@ -125,7 +125,7 @@ of failing."
         (delete-region pos next-pos)))))
 
 (defun mistty--remove-fake-newlines (start end)
-  "Remove newlines marked \='term-line-wrap between START and END."
+  "Remove newlines marked \\='term-line-wrap between START and END."
   (save-excursion
     (goto-char start)
     (while (search-forward "\n" end 'noerror)

diff --git a/mistty.el b/mistty.el
@@ -1186,7 +1186,7 @@ See the documentation of `mistty-create' for details."
   (mistty-create command 'other-window))
 
 (defun mistty--read-default-directory ()
-  "Get the default directory "
+  "Get the default directory."
   (read-directory-name "Default directory: " default-directory default-directory t nil))
 
 (defun mistty--process-sentinel (proc msg)