another attempt to close #178 #184

Merged
merged 1 commit into from Feb 7, 2014

Projects

None yet

2 participants

@yihui

@hadley Is this what you meant?

@hadley hadley and 1 other commented on an outdated diff Feb 6, 2014
R/roxygenize.R
@@ -65,11 +65,12 @@ load_options <- function(base_path) {
if (is.na(desc_opts)) {
opts <- list()
} else {
+ message("Loading options from the Roxygen field in DESCRIPTION: ", desc_opts)
@hadley
hadley Feb 6, 2014

Yes, but I think the message should only occur if no options are set - i.e. if you've set them then you know that they exist. If you haven't set them, you don't know about them.

With this change (and the new comments) I wonder if I should bump the version number to 4.0.0

@yihui
yihui Feb 6, 2014

Do we need a message at all if we mention this change in the news? I would find the message (mildly) annoying when I do not set Roxygen in DESCRIPTION and roxygen2 tells me wrap=FALSE is the default value every time.

@hadley
hadley Feb 6, 2014

The point is to be mildly annoying so you modify the DESCRIPTION. In my experience hardly anyone reads the NEWS so you definitely can't rely on it.

@yihui
yihui Feb 6, 2014

But modifying DESCRIPTION is more annoying because R CMD check says

Possibly mis-spelled fields in DESCRIPTION:
  ‘Roxygen’

which may require an explanation to crandalf. You know I absolutely hate doing that.

Anyway, I'll do what you want.

@hadley
hadley Feb 6, 2014

That's there problem, not yours ;) Anyway, they haven't commented on the packages I've submitted that contain it.

@yihui
yihui Feb 6, 2014

How does the PR look now? A message is emitted when wrap is not found in DESCRIPTION.

@hadley
Collaborator

That's perfect, but can you keep the description as is so documenting roxygen2 doesn't raise a message?

@yihui

Done!

@hadley hadley merged commit 5ff3618 into klutometis:master Feb 7, 2014

1 check was pending

Details default The Travis CI build is in progress
@yihui yihui deleted the yihui:nowrap2 branch Feb 7, 2014
@yihui yihui added a commit to yihui/shiny that referenced this pull request Feb 12, 2014
@yihui yihui using roxygen2 4.0.0: the spurious changes are due to klutometis/roxy…
…gen#184 (text in Rd is no longer wrapped by default)
c4edae8
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment