[education/rkward/releases/0.8.1] rkward/rbackend/rpackages/rkward: Fix braces

Thomas Friedrichsmeier null at kde.org
Tue Apr 22 12:30:56 BST 2025


Git commit e06c0a18f2e52bb532e8a2816338821bcf3fbc0c by Thomas Friedrichsmeier.
Committed on 22/04/2025 at 11:30.
Pushed by tfry into branch 'releases/0.8.1'.

Fix braces

M  +1    -1    rkward/rbackend/rpackages/rkward/DESCRIPTION
M  +1    -1    rkward/rbackend/rpackages/rkward/R/rk.menu.R
M  +12   -1    rkward/rbackend/rpackages/rkward/man/rk.menu.Rd

https://invent.kde.org/education/rkward/-/commit/e06c0a18f2e52bb532e8a2816338821bcf3fbc0c

diff --git a/rkward/rbackend/rpackages/rkward/DESCRIPTION b/rkward/rbackend/rpackages/rkward/DESCRIPTION
index 80ae65ce1..5b8ce0cd4 100755
--- a/rkward/rbackend/rpackages/rkward/DESCRIPTION
+++ b/rkward/rbackend/rpackages/rkward/DESCRIPTION
@@ -15,7 +15,7 @@ LazyLoad: yes
 Authors at R: c(person(given="Thomas", family="Friedrichsmeier", email="thomas.friedrichsmeier at kdemail.net", role=c("aut")), person(given="the RKWard", family="team",
                     email="rkward-devel at kde.org", role=c("cre","aut")))
 Version: 0.8.1
-Date: 2025-04-21
+Date: 2025-04-22
 RoxygenNote: 7.3.2
 Collate: 
     'base_overrides.R'
diff --git a/rkward/rbackend/rpackages/rkward/R/rk.menu.R b/rkward/rbackend/rpackages/rkward/R/rk.menu.R
index 094693726..fcedc9cef 100644
--- a/rkward/rbackend/rpackages/rkward/R/rk.menu.R
+++ b/rkward/rbackend/rpackages/rkward/R/rk.menu.R
@@ -40,7 +40,7 @@
 #'          \itemize{
 #'              \item \code{current_filename}: Specified if, and only if a script editor window is currently active: The filename of that script.
 #'              \item \code{current_object}: Specified if, and only if a data editor/viewer window is currently active: The R object being edited/views.
-#'                    To refer to the "name" of this object, use \code{deparse(substitute(current_object))} (see also \code{\link{rk.get.description}).
+#'                    To refer to the "name" of this object, use \code{deparse(substitute(current_object))} (see also \code{\link{rk.get.description}}).
 #'                    Similarly, it is possible to assign to the given object using \code{eval(substitute(current_object <- value), envir=globalenv())}.
 #'                    It is strongly recommended, however, not to modify data, without asking for explicit confirmation by the user, first (see
 #'                    \code{\link{rk.ask.question}}).
diff --git a/rkward/rbackend/rpackages/rkward/man/rk.menu.Rd b/rkward/rbackend/rpackages/rkward/man/rk.menu.Rd
index 3ace85849..8e2d5363e 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.menu.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.menu.Rd
@@ -39,7 +39,18 @@ Allows to add (and subsequently remove) menu items associated to specific plain
              us feedback on what you would like to see added. Only items defined using this mechanism can be manipulated / removed.
 }
 \details{
-
+The R function associated with a menu item will be called with the following (named, not positional) parameters:
+         \itemize{
+             \item \code{current_filename}: Specified if, and only if a script editor window is currently active: The filename of that script.
+             \item \code{current_object}: Specified if, and only if a data editor/viewer window is currently active: The R object being edited/views.
+                   To refer to the "name" of this object, use \code{deparse(substitute(current_object))} (see also \code{\link{rk.get.description}}).
+                   Similarly, it is possible to assign to the given object using \code{eval(substitute(current_object <- value), envir=globalenv())}.
+                   It is strongly recommended, however, not to modify data, without asking for explicit confirmation by the user, first (see
+                   \code{\link{rk.ask.question}}).
+             \item \code{current_dataframe}: Identical to \code{current_object}, but provided only, if the current object is a \code{data.frame}.
+             \item \code{...}: To swallow unused argumens, and for compatibility with future extensions, you function should always accept a
+                   \code{...}-parameter.
+         }
 }
 \section{Methods}{
 


More information about the rkward-tracker mailing list