Skip to contents

Docstring Template

Source: R/doc.R
DOCSTRING_TEMPLATE.Rd

A minimal docstring template

Usage

DOCSTRING_TEMPLATE

Format

A single string, i.e. a character vector of length 1.

Examples

cat(DOCSTRING_TEMPLATE)
#> #' @title TODO (e.g. 'Sum of Vector Elements')
#> #' @description TODO (e.g. 'sum returns the sum of all the values present in its arguments.'