Skip to content

Use Markdown for function documentation #54

@peterdesmet

Description

@peterdesmet

I didn't know this, but you can use Markdown in addition to Roxygen syntax for function document: http://klutometis.github.io/roxygen/articles/markdown.html, by adding to DESCRIPTION:

Roxygen: list(markdown = TRUE)

It basically gets rid of all the something{text} syntax, making it easier to write and read.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions