[Rd] documentation problems in str.Rd (PR#899)

Kurt.Hornik@ci.tuwien.ac.at Kurt.Hornik@ci.tuwien.ac.at
Sat, 7 Apr 2001 23:56:53 +0200 (MET DST)

File `src/library/base/man/str.Rd' shows the usage

  ls.str(name, pattern, mode = "any", max.level = 1, give.attr = FALSE)

whereas the code for ls.str() really has

  function (..., mode = "any", max.level = 1, give.attr = FALSE)

where the `...' is passed to ls().

The usage indicates `pattern' as a positional argument, which it is not.
Hence, e.g.
  ls.str("package:base", "^a")
will not work as documented.

I think one needs to document the `...' structure and say that the ...
args are passed on to ls().

Also, currently arguments `name', `pattern' and `mode' to ls.str() and
argument `...' to lsf.str() and the str* functions are not documented.

--please do not edit the information below--

 platform = i686-pc-linux-gnu
 arch = i686
 os = linux-gnu
 system = i686, linux-gnu
 status = Patched
 major = 1
 minor = 2.2
 year = 2001
 month = 04
 day = 07
 language = R

Search Path:
 .GlobalEnv, package:kh, Autoloads, package:base

r-devel mailing list -- Read http://www.ci.tuwien.ac.at/~hornik/R/R-FAQ.html
Send "info", "help", or "[un]subscribe"
(in the "body", not the subject !)  To: r-devel-request@stat.math.ethz.ch