[Rd] utils package: .Rd to .dvi (PR#9079)
rmh at temple.edu
rmh at temple.edu
Fri Jul 14 15:22:35 CEST 2006
# R for Windows will not send your bug report automatically.
# Please copy the bug report (after finishing it) to
# your favorite email program and send it to
#
# r-bugs at r-project.org
#
######################################################
I am building a package. I discovered that all \usage{} and
\examples{} in the .Rd file that are too long to fit on the .dvi page
are left as is. They run over the edge of the page and just keep on
going.
I propose that a WARNING or ERROR be generated as part of Rcmd check
for such cases.
The "test <-" line and both "test(" lines below are single lines.
My mailer folds at about 100 characters.
Rich
## test/R/test.R
test <- function(this, is, a, very, long, argument, list, designed, to, show, the, difficulty,
with, .Rd, To, .dvi, conversion) {
"Hello, World!"
}
## end test/R/test.R
## test/man/test.Rd
\name{test}
\alias{test}
\title{demonstrate a problem}
\description{demonstrate a problem}
\usage{
test(this, is, a, very, long, argument, list, designed, to, show, the, difficulty, with, .Rd,
To, .dvi, conversion)
}
\arguments{
\item{this}{}
\item{is}{}
\item{a}{}
\item{very}{}
\item{long}{}
\item{argument}{}
\item{list}{}
\item{designed}{}
\item{to}{}
\item{show}{}
\item{the}{}
\item{difficulty}{}
\item{with}{}
\item{.Rd}{}
\item{To}{}
\item{.dvi}{}
\item{conversion}{}
}
\examples{
test(this, is, a, very, long, argument, list, designed, to, show, the, difficulty, with, .Rd,
To, .dvi, conversion)
}
\keyword{package}
## end test/man/test.Rd
## test/DESCRIPTION
Package: test
Type: Package
Title: demonstrate a problem
Version: 1.0
Date: 2006-05-15
Author: Richard M. Heiberger
Maintainer: Richard M. Heiberger <rmh at temple.edu>
Depends: R (>= 2.3.1)
Description: demonstrate a problem
License: GPL version 2 or newer
## test/DESCRIPTION
--please do not edit the information below--
Version:
platform = i386-pc-mingw32
arch = i386
os = mingw32
system = i386, mingw32
status =
major = 2
minor = 3.1
year = 2006
month = 06
day = 01
svn rev = 38247
language = R
version.string = Version 2.3.1 (2006-06-01)
Windows XP Professional (build 2600) Service Pack 2.0
Locale:
LC_COLLATE=English_United States.1252;LC_CTYPE=English_United
States.1252;LC_MONETARY=English_United States.1252;LC_NUMERIC=C;LC_TIME=English_United States.1252
Search Path:
.GlobalEnv, package:methods, package:stats, package:utils, package:datasets,
file:c:/HOME/rmh/h2/library/H2/.RData, file:c:/HOME/rmh/hh/splus.library/HH/.RData,
package:multcomp, package:mvtnorm, package:graphics, package:lattice, package:grid,
package:grDevices, Autoloads, package:base
More information about the R-devel
mailing list