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

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

[elpa] externals/org c703541ffc 4/4: * lisp/ob-groovy.el: Fix checkdoc w


From: ELPA Syncer
Subject: [elpa] externals/org c703541ffc 4/4: * lisp/ob-groovy.el: Fix checkdoc warnings
Date: Sat, 16 Sep 2023 06:58:46 -0400 (EDT)

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

    * lisp/ob-groovy.el: Fix checkdoc warnings
    
    (org-babel-execute:groovy):
    (org-babel-groovy-evaluate): Document all the function arguments.
    (org-babel-groovy-initiate-session): Fix the docstring, explaining
    that function does nothing.
---
 lisp/ob-groovy.el | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/lisp/ob-groovy.el b/lisp/ob-groovy.el
index c0da69fcbf..8c05a24961 100644
--- a/lisp/ob-groovy.el
+++ b/lisp/ob-groovy.el
@@ -50,7 +50,7 @@ parameters may be used, like groovy -v"
   :type 'string)
 
 (defun org-babel-execute:groovy (body params)
-  "Execute a block of Groovy code with org-babel.
+  "Execute Groovy BODY according to PARAMS.
 This function is called by `org-babel-execute-src-block'."
   (message "Executing Groovy source code block")
   (let* ((processed-params (org-babel-process-params params))
@@ -81,6 +81,7 @@ println(new Runner().run())
 (defun org-babel-groovy-evaluate
     (session body &optional result-type result-params)
   "Evaluate BODY in external Groovy process.
+SESSION must be nil as sessions are not yet supported.
 If RESULT-TYPE equals `output' then return standard output as a string.
 If RESULT-TYPE equals `value' then return the value of the last statement
 in BODY as elisp."
@@ -107,9 +108,8 @@ in BODY as elisp."
   (error "Sessions are not (yet) supported for Groovy"))
 
 (defun org-babel-groovy-initiate-session (&optional _session)
-  "If there is not a current inferior-process-buffer in SESSION
-then create.  Return the initialized session.  Sessions are not
-supported in Groovy."
+  "Do nothing.
+Sessions are not supported in Groovy."
   nil)
 
 (provide 'ob-groovy)



reply via email to

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