emacs-elpa-diffs
[Top][All Lists]
Advanced

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

[elpa] externals/org c952ff10fb 3/3: * lisp/ob-ruby.el: Document all the


From: ELPA Syncer
Subject: [elpa] externals/org c952ff10fb 3/3: * lisp/ob-ruby.el: Document all the function arguments
Date: Tue, 10 Oct 2023 09:58:56 -0400 (EDT)

branch: externals/org
commit c952ff10fb34afe0a4c0ea02f85255a7ff467625
Author: Ihor Radchenko <yantar92@posteo.net>
Commit: Ihor Radchenko <yantar92@posteo.net>

    * lisp/ob-ruby.el: Document all the function arguments
    
    (org-babel-execute:ruby):
    (org-babel-variable-assignments:ruby):
    (org-babel-ruby-initiate-session):
---
 lisp/ob-ruby.el | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/lisp/ob-ruby.el b/lisp/ob-ruby.el
index 227b14daa0..904008d2fb 100644
--- a/lisp/ob-ruby.el
+++ b/lisp/ob-ruby.el
@@ -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)



reply via email to

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