doc for r88132: help() pdf rendering can turn off message via print(*, msg=FALSE)

git-svn-id: https://svn.r-project.org/R/trunk@88165 00db46b3-68df-0310-9c12-caf00c1e9a41

Author: maechler

src/library/utils/R/help.R

@@ -253,8 +253,8 @@ print.help_files_with_topic <- function(x, ...) # ...  may contain  msg=FALSE
     on.exit(unlink(texfile)) ## ? leave to helper
     helper <- get0("offline_help_helper", envir = .GlobalEnv) %||% offline_help_helper # <-> below
     if (attr(texfile, "has_figure"))
-         helper(texfile, type, texinputs=texinputs, msg=msg)
-    else helper(texfile, type,                      msg=msg)
+         helper(texfile, type, msg=msg, texinputs=texinputs)
+    else helper(texfile, type, msg=msg)
     invisible()
 }
 
@@ -273,7 +273,7 @@ print.help_files_with_topic <- function(x, ...) # ...  may contain  msg=FALSE
 }
 
 
-offline_help_helper <- function(texfile, type, texinputs = NULL, msg = TRUE)
+offline_help_helper <- function(texfile, type, msg = TRUE, texinputs = NULL)
 {
     ## Some systems have problems with texfile names like ".C.tex"
     tf <- tempfile("tex", tmpdir = ".", fileext = ".tex"); on.exit(unlink(tf))

src/library/utils/man/help.Rd

@@ -1,6 +1,6 @@
 % File src/library/utils/man/help.Rd
 % Part of the R package, https://www.R-project.org
-% Copyright 1995-2018 R Core Team
+% Copyright 1995-2025 R Core Team
 % Distributed under GPL 2 or later
 
 \name{help}
@@ -120,9 +120,11 @@ help(topic, package = NULL, lib.loc = NULL,
   If there is a function \code{offline_help_helper} in the workspace or
   further down the search path it is used to do the typesetting,
   otherwise the function of that name in the \code{utils} namespace (to
-  which the first paragraph applies).  It should accept at least two
-  arguments, the name of the LaTeX file to be typeset and the type
-  (which is nowadays ignored).  It accepts a third argument,
+  which the first paragraph applies).  It should accept at least three
+  arguments, the name of the LaTeX file to be typeset, the type
+  (which is nowadays ignored), and a logical \code{msg} indicating if a
+  \code{\link{message}()} about the pdf creation should be signalled.  It
+  accepts also an argument
   \code{texinputs}, which will give the graphics path when the help
   document contains figures, and will otherwise not be supplied.
 }