[education/rkward/releases/0.7.4] rkward/rbackend/rpackages/rkward: Roxygenize

Thomas Friedrichsmeier null at kde.org
Mon May 23 12:14:05 BST 2022


Git commit 115ff7b0ac6ec6de0ef1bf71ff6cc884adaac0ac by Thomas Friedrichsmeier.
Committed on 23/05/2022 at 11:13.
Pushed by tfry into branch 'releases/0.7.4'.

Roxygenize

M  +1    -1    rkward/rbackend/rpackages/rkward/DESCRIPTION
M  +10   -5    rkward/rbackend/rpackages/rkward/man/rk.capture.output.Rd

https://invent.kde.org/education/rkward/commit/115ff7b0ac6ec6de0ef1bf71ff6cc884adaac0ac

diff --git a/rkward/rbackend/rpackages/rkward/DESCRIPTION b/rkward/rbackend/rpackages/rkward/DESCRIPTION
index 2f4d787d..59d862fd 100755
--- a/rkward/rbackend/rpackages/rkward/DESCRIPTION
+++ b/rkward/rbackend/rpackages/rkward/DESCRIPTION
@@ -18,7 +18,7 @@ Authors at R: c(person(given="Thomas", family="Friedrichsmeier",
         role=c("aut")), person(given="the RKWard team",
         email="rkward-devel at kde.org", role=c("cre","ctb")))
 Version: 0.7.4
-Date: 2022-05-20
+Date: 2022-05-23
 RoxygenNote: 7.1.2
 Collate: 
     'base_overrides.R'
diff --git a/rkward/rbackend/rpackages/rkward/man/rk.capture.output.Rd b/rkward/rbackend/rpackages/rkward/man/rk.capture.output.Rd
index 916111c6..359350bb 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.capture.output.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.capture.output.Rd
@@ -9,12 +9,21 @@ rk.capture.output(
   capture.messages = TRUE,
   capture.output = TRUE,
   suppress.messages = FALSE,
-  suppress.output = FALSE
+  suppress.output = FALSE,
+  allow.nesting = TRUE
 )
 
 rk.end.capture.output(highlight = FALSE)
 }
 \arguments{
+\item{suppress.output}{output / message are not sent on, neither to surrounding captures, nor as regular output}
+
+\item{allow.nesting}{if false, output / message is not sent to surrounding captures, but is sent to regular output (unless suppressed)
+
+\code{rk.capture.output} Starts capturing output.
+
+\code{rk.end.capture.output} Stops capturing output, and returns the recorded output in a string.}
+
 \item{LANG}{language code to use. "C" for no translation, i.e. generally English}
 }
 \description{
@@ -26,8 +35,4 @@ with the default being to print it.
 }
 \details{
 And arbitrary number of ouptut captures can be started and stopped, and these will form a push/pop stack.
-
-\code{rk.capture.output} Starts capturing output.
-
-\code{rk.end.capture.output} Stops capturing output, and returns the recorded output in a string.
 }


More information about the rkward-tracker mailing list