Rd (version 0.2.0)

Rd_clean_indent: Check and clean an indent string

Description

Check and clean an indent string

Usage

Rd_clean_indent(indent.with, type = get_Rd_tag(indent.with))

Arguments

indent.with

The string to use for indentation.

type

The type of string the indent is to be.

Value

An Rd_string, of type 'TEXT' or 'CODE', see details, wrapped in an Rd container.

Details

Indents must have the following characteristics:

• They must be all whitespace, i.e. spaces.

• Newlines are not allowed.

• Tabs, are allowed with a warning as they violate the guidelines.

• May only be Rd_strings of tag type TEXT or RCODE. Code type should only be used to indent other text.

See Also

https://developer.r-project.org/Rds.html