Skip to content

Commit a7dff8c

Browse files
committed
* lisp/org/ob-lua.el: Minor doc fixes.
1 parent 0d1edec commit a7dff8c

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

lisp/org/ob-lua.el

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,14 @@
2323

2424
;;; Commentary:
2525

26-
;; Org-Babel support for evaluating lua source code.
26+
;; Org-Babel support for evaluating Lua source code.
2727

2828
;; Requirements:
2929
;; for session support, lua-mode is needed.
30+
;;
3031
;; lua-mode is not part of GNU Emacs/orgmode, but can be obtained
31-
;; from marmalade or melpa.
32+
;; from NonGNU ELPA (see `M-x list-packages').
33+
;;
3234
;; The source repository is here:
3335
;; https://github.com/immerrr/lua-mode
3436

@@ -68,14 +70,14 @@ This will typically be `lua-mode'."
6870
:type 'symbol)
6971

7072
(defcustom org-babel-lua-hline-to "None"
71-
"Replace hlines in incoming tables with this when translating to lua."
73+
"Replace hlines in incoming tables with this when translating to Lua."
7274
:group 'org-babel
7375
:version "26.1"
7476
:package-version '(Org . "8.3")
7577
:type 'string)
7678

7779
(defcustom org-babel-lua-None-to 'hline
78-
"Replace `None' in lua tables with this before returning."
80+
"Replace `None' in Lua tables with this before returning."
7981
:group 'org-babel
8082
:version "26.1"
8183
:package-version '(Org . "8.3")
@@ -145,8 +147,8 @@ The variable definitions are defining in PARAMS."
145147
(org-babel--get-vars params)))
146148

147149
(defun org-babel-lua-var-to-lua (var)
148-
"Convert an elisp value to a lua variable.
149-
Convert an elisp value, VAR, into a string of lua source code
150+
"Convert an Emacs Lisp value to a Lua variable.
151+
Convert an Emacs Lisp value, VAR, into a string of Lua source code
150152
specifying a variable of the same value."
151153
(if (listp var)
152154
(if (and (= 1 (length var)) (not (listp (car var))))
@@ -207,7 +209,7 @@ Emacs-lisp table, otherwise return the results as a string."
207209
(defvar lua-which-bufname)
208210
(defvar lua-shell-buffer-name)
209211
(defun org-babel-lua-initiate-session-by-key (&optional session)
210-
"Initiate a lua session.
212+
"Initiate a Lua session.
211213
If there is not a current inferior-process-buffer in SESSION
212214
then create. Return the initialized session."
213215
;; (require org-babel-lua-mode)
@@ -317,7 +319,7 @@ PREAMBLE is passed to `org-babel-lua-evaluate-external-process'."
317319
"Evaluate BODY in external Lua process.
318320
If RESULT-TYPE equals `output' then return standard output as a
319321
string. If RESULT-TYPE equals `value' then return the value of the
320-
last statement in BODY, as elisp.
322+
last statement in BODY, as Emacs Lisp.
321323
RESULT-PARAMS list all the :result header arg parameters.
322324
PREAMBLE string is appended to BODY."
323325
(let ((raw
@@ -353,7 +355,7 @@ PREAMBLE string is appended to BODY."
353355
"Pass BODY to the Lua process in SESSION.
354356
If RESULT-TYPE equals `output' then return standard output as a
355357
string. If RESULT-TYPE equals `value' then return the value of the
356-
last statement in BODY, as elisp."
358+
last statement in BODY, as Emacs Lisp."
357359
(let* ((send-wait (lambda () (comint-send-input nil t) (sleep-for 0.005)))
358360
(dump-last-value
359361
(lambda

0 commit comments

Comments
 (0)