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

Global roxygen options for a package #507

Closed
gaborcsardi opened this issue Sep 16, 2016 · 5 comments
Closed

Global roxygen options for a package #507

gaborcsardi opened this issue Sep 16, 2016 · 5 comments
Labels

Comments

@gaborcsardi
Copy link
Collaborator

@gaborcsardi gaborcsardi commented Sep 16, 2016

We would put them in the DESCRIPTION file, in the Roxygen field, which is allowed, but not used currently.

The plan is to have R code there, and initially we would support switching Markdown parsing on/off:

Roxygen: list(markdown = TRUE)

I will submit a PR in the coming days.

@hadley hadley added the feature label Sep 20, 2016
@gaborcsardi
Copy link
Collaborator Author

@gaborcsardi gaborcsardi commented Sep 20, 2016

I see you are finishing things up. I'll try to write this tomorrow.

@hadley
Copy link
Member

@hadley hadley commented Sep 21, 2016

I'd also consider turning markdown on by default, and we can see how it goes when applied to my packages.

@gaborcsardi
Copy link
Collaborator Author

@gaborcsardi gaborcsardi commented Sep 21, 2016

Of course you would turn it on, because you can blame me if sg goes wrong.
:)

With the current link implementation, there will be problems with Rd
brackets for example.

Why don't we just turn it on for your packages?

Regardless, we need this global switch, I think. I'll write it tonight.

On 21 Sep 2016 19:55, "Hadley Wickham" notifications@github.com wrote:

I'd also consider turning markdown on by default, and we can see how it
goes when applied to my packages.


You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
#507 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/AAoTQEvkOaWOQVcNHsp4jM4CoNARLyGIks5qsX2MgaJpZM4J-y3k
.

@gaborcsardi
Copy link
Collaborator Author

@gaborcsardi gaborcsardi commented Sep 21, 2016

Wait a sec, there is code for this already: https://github.com/klutometis/roxygen/blob/596893c42b48aaa91781a60ffaad3c2dc0000ac0/R/roxygenize.R#L86

I am sorry, I wasn't aware of this. So I can just all markdown here.....

hadley added a commit that referenced this issue Sep 22, 2016
* Global options from Roxygen: in DESCRIPTION, for #507

Also add the @nomd tag.

* Test cases for turning markdown on/off globally

* Turn on markdown for roxygen2 itself

* Update markdown vignette for new global option & @nomd

* Fix wrong entry in NEWS file

* Add relevant issues to NEWS file, markdown entry

* markdown NEWS: mention global flag, @md @nomd
@gaborcsardi
Copy link
Collaborator Author

@gaborcsardi gaborcsardi commented Oct 20, 2016

This can be closed, there is a way, the Roxygen field. It works fine for markdown.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants