make_description: Create a GitHub description string for a package

View source: R/description.R

make_descriptionR Documentation

Create a GitHub description string for a package

Description

On GitHub the description cannot contain newline characters, and HTML tags are not allowed, either. But it is possible to include non-breaking space characters, and this results for a nice multi-line description for most packages.

Usage

make_description(pkg)

Arguments

pkg

Package name, or a description object.

Value

Character scalar, an appropriate GitHub repository description.


metacran/cranatgh documentation built on Feb. 11, 2024, 2:20 p.m.