From 0eb9aa798ca39a8a20178cada5c4b7f137bd1ed8 Mon Sep 17 00:00:00 2001 From: Ihor Radchenko Date: Thu, 10 Aug 2023 13:58:14 +0300 Subject: [PATCH] * lisp/ob-R.el: Fix some checkdoc warnings (org-babel-execute:R): (org-babel-variable-assignments:R): (org-babel-R-initiate-session): Mention all the argument in the docstring. --- lisp/ob-R.el | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/lisp/ob-R.el b/lisp/ob-R.el index 7ea137197..c5f1db40b 100644 --- a/lisp/ob-R.el +++ b/lisp/ob-R.el @@ -156,7 +156,7 @@ This function is used when the table does not contain a header.") "\n")) (defun org-babel-execute:R (body params) - "Execute a block of R code. + "Execute a block of R code BODY according to PARAMS. This function is called by `org-babel-execute-src-block'." (save-excursion (let* ((result-params (cdr (assq :result-params params))) @@ -215,7 +215,8 @@ This function is called by `org-babel-execute-src-block'." ;; helper functions (defun org-babel-variable-assignments:R (params) - "Return list of R statements assigning the block's variables." + "Return list of R statements assigning the block's variables. +Retrieve variables from PARAMS." (let ((vars (org-babel--get-vars params))) (mapcar (lambda (pair) @@ -263,7 +264,8 @@ This function is called by `org-babel-execute-src-block'." (defvar ess-ask-for-ess-directory) ; dynamically scoped (defun org-babel-R-initiate-session (session params) - "If there is not a current R process then create one." + "Create or return the current R SESSION buffer. +Use PARAMS to set default directory when creating a new session." (unless (string= session "none") (let ((session (or session "*R*")) (ess-ask-for-ess-directory