* 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.
This commit is contained in:
parent
39ae2eda5b
commit
0eb9aa798c
|
@ -156,7 +156,7 @@ This function is used when the table does not contain a header.")
|
||||||
"\n"))
|
"\n"))
|
||||||
|
|
||||||
(defun org-babel-execute:R (body params)
|
(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'."
|
This function is called by `org-babel-execute-src-block'."
|
||||||
(save-excursion
|
(save-excursion
|
||||||
(let* ((result-params (cdr (assq :result-params params)))
|
(let* ((result-params (cdr (assq :result-params params)))
|
||||||
|
@ -215,7 +215,8 @@ This function is called by `org-babel-execute-src-block'."
|
||||||
;; helper functions
|
;; helper functions
|
||||||
|
|
||||||
(defun org-babel-variable-assignments:R (params)
|
(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)))
|
(let ((vars (org-babel--get-vars params)))
|
||||||
(mapcar
|
(mapcar
|
||||||
(lambda (pair)
|
(lambda (pair)
|
||||||
|
@ -263,7 +264,8 @@ This function is called by `org-babel-execute-src-block'."
|
||||||
|
|
||||||
(defvar ess-ask-for-ess-directory) ; dynamically scoped
|
(defvar ess-ask-for-ess-directory) ; dynamically scoped
|
||||||
(defun org-babel-R-initiate-session (session params)
|
(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")
|
(unless (string= session "none")
|
||||||
(let ((session (or session "*R*"))
|
(let ((session (or session "*R*"))
|
||||||
(ess-ask-for-ess-directory
|
(ess-ask-for-ess-directory
|
||||||
|
|
Loading…
Reference in New Issue