Markdown headers

[jeroen]

Adding a markdown header yiels a strange error message:

#'  Blabla bla
#' 
#' ## Output streams
#'
#' Blabla

Same happens for underline header

#' Blabla
#'
#' Output streams
#' ---
#'
#' Blabla

This is the error:

> roxygen2::roxygenise()
Error in markdown_rparse(markdown_tags[[xml_name(xml)]](xml), markdown_tags = markdown_tags) : 
  attempt to apply non-function

[gaborcsardi]

HEaders are not supported, but I agree that the error message should be better.

[jeroen]

OK. Is there any way to get custom section titles such as e.g. in ?connection manual page?

[gaborcsardi]

@ section ?

…

On 13 Jan 2017 20:19, "Jeroen Ooms" ***@***.***> wrote: OK. Is there any way to get custom section titles such as e.g. in ?connection manual page? — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#560 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAoTQPDB2xN3KHUsd_L4dMlyLp7XikMLks5rR9xtgaJpZM4LjQV8> .

[jeroen]

OK thanks :) I assumed it was a layout feature, not a Rd tag. Perhaps we can map markdown headers to @section tags.

[gaborcsardi]

WEll, @section is a roxygen tag, not Rd. Right now we do a separate markdown parsing for each roxygen tag.

[brodieG]

Fyi, this gets triggered by having something like #' <hello hello> in the docs, presumably because it tries to interpret it as some kind of markup tag and there is no equivalent value roxygen2:::markdown_tags.

[jarauh]

It would be good to mention in the documentation that sections are not supported. The introduction of https://cran.r-project.org/web/packages/roxygen2/vignettes/markdown.html ends with:

See http://commonmark.org/help/ for more about the parser and the markdown language it supports.

This suggests that roxygen2 does work with sections.