Global option for markdown

[gaborcsardi]

For #507

We read the options via the usual load_options() in roxygenize(), and then push them down the call chain (almost) everywhere. parse_text() also gets a global_options argument.

In each function where I added the global_options argument, I also added a default value (list()), so that we don't break other packages.

While this is done, and works, I don't think it is ideal. The best would be to attach the options to some package object, and make this reachable from block objects. Roxygen does not really have the organization to implement this cleanly, AFAICT.

Another option would be a global options store, but my problem with that is that it is hard to invalidate, and that these options really belong to the package and the blocks, not to roxygen itself.

[hadley]

Can you mention the global flag and @md/@noMd here too please?

[gaborcsardi]

OK, so here. :) GH email notifications lose the context sometimes.

[gaborcsardi]

OK, updated the NEWS.

[hadley]

I agree it's not the ideal approach but it works and doesn't need extensive changes to roxygen2. If you make that one change to NEWS.md, I'll merge

[gaborcsardi]

Sure. You want another bullet point or in the same point?

On 22 Sep 2016 14:15, "Hadley Wickham" notifications@github.com wrote:

@hadley commented on this pull request.

In NEWS.md
#515 (review)
:

• Most fields can now be written using Markdown markup instead of the
  traditional Rd language. See the 'markdown' vignette for details
  • (Preref parser for auto-detected title, description and details #364, Markdown #431), by @gaborcsardi
  • (Preref parser for auto-detected title, description and details #364, Markdown #431, Vignette for markdown #499, Easier links in Markdown #506, Global roxygen options for a package #507), by @gaborcsardi

Can you mention the global flag and @md/@nomd here too please?

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

[gaborcsardi]

Btw. I'll also update release a new version of desc tonight to get rid of the annoying Collate formatting and the trailing space craziness.

[hadley]

Thanks!