emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/org edff094b5f 1/2: * lisp/ol-eshell.el: Fix docstrings


From: ELPA Syncer
Subject: [elpa] externals/org edff094b5f 1/2: * lisp/ol-eshell.el: Fix docstrings
Date: Sat, 21 Oct 2023 09:58:42 -0400 (EDT)

branch: externals/org
commit edff094b5f27b131347ee57f23c799e95ec6cbf6
Author: Ihor Radchenko <yantar92@posteo.net>
Commit: Ihor Radchenko <yantar92@posteo.net>

    * lisp/ol-eshell.el: Fix docstrings
    
    (org-eshell-open): Document the function argument.
    (org-eshell-store-link): Make the first docstring line into a single
    sentence.
---
 lisp/ol-eshell.el | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/lisp/ol-eshell.el b/lisp/ol-eshell.el
index b7d3baf389..1c52dfa0d6 100644
--- a/lisp/ol-eshell.el
+++ b/lisp/ol-eshell.el
@@ -37,8 +37,8 @@
                         :store #'org-eshell-store-link)
 
 (defun org-eshell-open (link _)
-  "Switch to an eshell buffer and execute a command line.
-The link can be just a command line (executed in the default
+  "Switch to an eshell buffer and execute a command line for LINK.
+The LINK can be just a command line (executed in the default
 eshell buffer) or a command line prefixed by a buffer name
 followed by a colon."
   (let* ((buffer-and-command
@@ -61,8 +61,9 @@ followed by a colon."
     (eshell-send-input)))
 
 (defun org-eshell-store-link ()
-  "Store a link that, when opened, switches back to the current eshell buffer
-and the current working directory."
+  "Store eshell link.
+When opened, the link switches back to the current eshell buffer and
+the current working directory."
   (when (eq major-mode 'eshell-mode)
     (let* ((command (concat "cd " (eshell/pwd)))
            (link  (concat (buffer-name) ":" command)))



reply via email to

[Prev in Thread] Current Thread [Next in Thread]