Re: [R-pkg-devel] Rd File Line Widths Not Suggested in Manual

2017-11-22 Thread Heather Turner
Dear Dario,

There is a note in the Guidelines for Rd files
(https://developer.r-project.org/Rds.html) which is linked to in Sec 2.1
of R-ext.

It could be useful for these guidelines could be incorporated in R-ext
itself so people don't have to look in two different places, but I think
some of the guidelines are more critical than others.  (Who puts two
spaces after a period these days??)

Best wishes,

Heather

On Wed, Nov 22, 2017, at 06:00 AM, Dario Strbenac wrote:
> Good day,
> 
> I often notice that some lines of code in many PDF manuals generated for
> CRAN packages run off the page. Perhaps the maximum number of characters
> per line should be stated in section 2.16 of Writing R Extensions. It
> would help package authors like me write better Rd files.
> 
> --
> Dario Strbenac
> University of Sydney
> Camperdown NSW 2050
> Australia
> 
> __
> R-package-devel@r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-package-devel

__
R-package-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-package-devel


Re: [R-pkg-devel] Rd File Line Widths Not Suggested in Manual

2017-11-22 Thread Duncan Murdoch

On 22/11/2017 1:00 AM, Dario Strbenac wrote:

Good day,

I often notice that some lines of code in many PDF manuals generated for CRAN 
packages run off the page. Perhaps the maximum number of characters per line 
should be stated in section 2.16 of Writing R Extensions. It would help package 
authors like me write better Rd files.


If you run R CMD check on your package, you'll get warnings about lines 
being too long.  New submissions to CRAN will have to follow these 
limits, but CRAN doesn't force package authors to update to meet them.


Duncan Murdoch

__
R-package-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-package-devel