emacs-diffs
[Top][All Lists]
Advanced

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

master e0070fc574a: Improve org-babel-execute:eshell docstring


From: Stefan Kangas
Subject: master e0070fc574a: Improve org-babel-execute:eshell docstring
Date: Sun, 17 Sep 2023 10:58:12 -0400 (EDT)

branch: master
commit e0070fc574a8621b2fbb1aaca678b974a3dc5fd5
Author: Stefan Kangas <stefankangas@gmail.com>
Commit: Stefan Kangas <stefankangas@gmail.com>

    Improve org-babel-execute:eshell docstring
    
    * lisp/org/ob-eshell.el (org-babel-execute:eshell): Improve docstring.
---
 lisp/org/ob-eshell.el | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/lisp/org/ob-eshell.el b/lisp/org/ob-eshell.el
index 95f5777ae7d..b3fbe3ad52d 100644
--- a/lisp/org/ob-eshell.el
+++ b/lisp/org/ob-eshell.el
@@ -47,11 +47,12 @@
   "Execute a block of Eshell code BODY with PARAMS.
 This function is called by `org-babel-execute-src-block'.
 
-The BODY can be any code which allowed executed in Eshell.
-Eshell allow to execute normal shell command and Elisp code.
-More details please reference Eshell Info.
+The BODY argument is code which can be executed in Eshell.
+Eshell allows executing normal shell command and Elisp code.
+For more details, see Info node `(eshell) Top'.
 
-The PARAMS are variables assignments."
+The PARAMS argument is passed to
+`org-babel-expand-body:generic' (which see)."
   (let* ((session (org-babel-eshell-initiate-session
                   (cdr (assq :session params))))
         (full-body (org-babel-expand-body:generic



reply via email to

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