* 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.
This commit is contained in:
parent
7ceefaf2d5
commit
edff094b5f
|
@ -37,8 +37,8 @@
|
||||||
:store #'org-eshell-store-link)
|
:store #'org-eshell-store-link)
|
||||||
|
|
||||||
(defun org-eshell-open (link _)
|
(defun org-eshell-open (link _)
|
||||||
"Switch to an eshell buffer and execute a command line.
|
"Switch to an eshell buffer and execute a command line for LINK.
|
||||||
The link can be just a command line (executed in the default
|
The LINK can be just a command line (executed in the default
|
||||||
eshell buffer) or a command line prefixed by a buffer name
|
eshell buffer) or a command line prefixed by a buffer name
|
||||||
followed by a colon."
|
followed by a colon."
|
||||||
(let* ((buffer-and-command
|
(let* ((buffer-and-command
|
||||||
|
@ -61,8 +61,9 @@ followed by a colon."
|
||||||
(eshell-send-input)))
|
(eshell-send-input)))
|
||||||
|
|
||||||
(defun org-eshell-store-link ()
|
(defun org-eshell-store-link ()
|
||||||
"Store a link that, when opened, switches back to the current eshell buffer
|
"Store eshell link.
|
||||||
and the current working directory."
|
When opened, the link switches back to the current eshell buffer and
|
||||||
|
the current working directory."
|
||||||
(when (eq major-mode 'eshell-mode)
|
(when (eq major-mode 'eshell-mode)
|
||||||
(let* ((command (concat "cd " (eshell/pwd)))
|
(let* ((command (concat "cd " (eshell/pwd)))
|
||||||
(link (concat (buffer-name) ":" command)))
|
(link (concat (buffer-name) ":" command)))
|
||||||
|
|
Loading…
Reference in New Issue