tec/org-mode
tec
/
org-mode
forked from mirrors/org-mode
1
0
Fork 0
Code Pull Requests Releases Activity

* lisp/ob-ruby.el: Document all the function arguments 

(org-babel-execute:ruby):
(org-babel-variable-assignments:ruby):
(org-babel-ruby-initiate-session):
This commit is contained in:
Ihor Radchenko 2023-10-10 15:30:35 +03:00
parent fe23bec607
commit c952ff10fb
No known key found for this signature in database
GPG Key ID: 6470762A7DA11D8B
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
lisp/ob-ruby.el
View File

@ -73,7 +73,7 @@ It's possible to override it by using a header argument `:ruby'")
:type 'symbol)
(defun org-babel-execute:ruby (body params)
"Execute a block of Ruby code with Babel.
"Execute Ruby BODY according to PARAMS.
This function is called by `org-babel-execute-src-block'."
(let* ((session (org-babel-ruby-initiate-session
(cdr (assq :session params)) params))
@ -127,7 +127,8 @@ This function is called by `org-babel-execute-src-block'."
;; helper functions
(defun org-babel-variable-assignments:ruby (params)
"Return list of ruby statements assigning the block's variables."
"Return list of ruby statements assigning the block's variables.
The assignments are defined in PARAMS."
(mapcar
(lambda (pair)
(format "%s=%s"
@ -165,7 +166,8 @@ Emacs-lisp table, otherwise return the results as a string."
(defun org-babel-ruby-initiate-session (&optional session params)
"Initiate a ruby session.
If there is not a current inferior-process-buffer in SESSION
then create one. Return the initialized session."
then create one. Return the initialized session.
Session settings (`:ruby' header arg value) are taken from PARAMS."
(unless (string= session "none")
(org-require-package 'inf-ruby)
(let* ((command (cdr (or (assq :ruby params)