wrapping causing errors

[jverzani]

Sometimes the wrapping of contents will occur and an entry like:

 \method{.getStockIconByName}{guiWidgetsToolkitQt}
    (toolkit, name, ...)

will happen. This causes a warning (Bad \usage lines found in documentation object ...) Whereas

 \method{.getStockIconByName}{guiWidgetsToolkitQt}  (toolkit, name, ...)

does not. Seems like something that should be fixed downstream. But in the absence of that, I can report that adjusting the width option in format_collapse to 600 (from 60) will fix the problem for me. Since Rd files aren't really meant to be read, I don't see why wrapping at 60 is desirable.

[hadley]

Hi John - we're wrapping Rd files because when you view them from the terminal wrapping does matter (and I was trying to match the style of base R documentation). I'll take a look when I'm working on roxygen2 next.

[jverzani]

Good points. It isn't really wrapping that is the issue, it is the breaking at }( that causes problems. Here is a small hack that works, likely you can make look prettier:

format_collapse <- function(x, ..., indent = 2, exdent = 2) {
values <- str_c(x$values, collapse = "\n\n")
values <- gsub("}\s+(", "}(", values) ## <---- right here
rd_tag(x$tag, str_wrap(values, width = 60, indent = indent,
exdent = exdent), space = TRUE)
}

[BrianDiggs]

Wrapping can also apparently cause problems with text parts of deqn as discussed in http://stackoverflow.com/q/14041601/892313

[hadley]

I think overall I'd like to move roxygen2 towards no wrapping, since this causes substantial problems.

[krlmlr]

Just for reference: #129 proposes a temporary solution.