diff options
| author | Stefan Kangas <stefankangas@gmail.com> | 2023-09-17 16:57:20 +0200 |
|---|---|---|
| committer | Stefan Kangas <stefankangas@gmail.com> | 2023-09-17 16:57:25 +0200 |
| commit | e0070fc574a8621b2fbb1aaca678b974a3dc5fd5 (patch) | |
| tree | 71083691fc04ff2471c752948a1d20bd8006ba00 /lisp/org | |
| parent | 1e270e580d3bb9ca1b3766a296611f76ec13f6f1 (diff) | |
Improve org-babel-execute:eshell docstring
* lisp/org/ob-eshell.el (org-babel-execute:eshell): Improve docstring.
Diffstat (limited to 'lisp/org')
| -rw-r--r-- | lisp/org/ob-eshell.el | 9 |
1 files 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 |