yonicd/sinew

don't define @title and @description tags explicitely

januz opened this issue · 1 comments

januz commented

I like the convention not to define the @title and @description tags explicitly, but to use the first line as the title, the rest up to the first tag as description as lined out here. I feel like it makes the documentation more readable.

Would it be possible to add an option to choose between the explicit and implicit version? Maybe just something like this in makeOxygen.R:

if (implicit) {
  header <- c(
      title = "#' FUNCTION_TITLE", "#'",
      description = "#' FUNCTION_DESCRIPTION", "#'"
    )
} else {
  header <- c(
      title = "#' @title FUNCTION_TITLE",
      description = "#' @description FUNCTION_DESCRIPTION"
    )
}

Or would that have negative consequences for other functions, e.g. moga()?

sorry. they are used in other functions of the package. removing the tags will cause moga and the interactive shiny application to crash.