completeDescription: completion for DESCRIPTION files

Description Usage Arguments Value Author(s) References See Also

View source: R/completeDescription.R

Description

Proposes completions for a DESCRIPTION file.

Usage

1
2
completeDescription(file, row, column, text = readLines(file), 
    author = getOption("svTools.description.author"))

Arguments

file

a DESCRIPTION file to complete.

row

line in the file where the cursor is located.

column

column in the file where the cursor is located.

text

text to complete.

author

how to complete Author fields. The default value looks for the "svTools.description.author" option.

Value

A list with the following items:

ok

logical indicating if there actually are completions.

data

character matrix. The first column gives the completion, the second a description.

token

token that is being completed.

type

type of results, can be \"package\", \"fields", \"other\".

Author(s)

Romain Francois <[email protected]>

References

Writing R extensions defines what should be in a DESCRIPTION file

See Also

lintDescription


svTools documentation built on May 29, 2017, 5:31 p.m.