Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add option to control wrapping #142

Merged
merged 7 commits into from Nov 18, 2013
Merged

Add option to control wrapping #142

merged 7 commits into from Nov 18, 2013

Conversation

hadley
Copy link
Member

@hadley hadley commented Nov 15, 2013

This also provides a straightforward mechanism to add other options to roxygen if need be (options should be reserved strictly for controlling backward compatibility, otherwise it is increases the testing load).

Fixes #132.

Add ability to change default roclets
@krlmlr
Copy link
Member

krlmlr commented Nov 15, 2013

The log of the last build, line 726, shows:

Possibly mis-spelled fields in DESCRIPTION:
  ‘Roxygen’

Can this become a problem?

@hadley
Copy link
Member Author

hadley commented Nov 15, 2013

That's just a note, so I think it's ok. R-exts says "There is no restriction on the use of other fields not mentioned here (but using other capitalizations of these field names would cause confusion)."

@@ -22,6 +22,7 @@ Imports:
Suggests:
testthat
LinkingTo: Rcpp
Roxygen: list(wrap = FALSE)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this the permanent solution, or will there be a nicer syntax like

Roxygen:
    wrap
    other_option=value

?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd prefer to stick to R code since it's straightforward to parse.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was just wondering if the name Roxygen@R would thus be more appropriate - since somehow consistent with the Authors@R field... However, if there is no plain text equivalent specification, sticking to a pure Roxygen definitely seems nicer.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I thought about that too, but on the balance, I think I prefer just Roxygen

hadley added a commit that referenced this pull request Nov 18, 2013
Add option to control wrapping
@hadley hadley merged commit 973c968 into master Nov 18, 2013
@hadley hadley deleted the wrap-opt branch November 18, 2013 22:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Turn off wrapping
3 participants