parsetools (version 0.1.1)

pd_get_relative_comment_associated_ids: Associate relative documentation comments

Description

Relative comment created with \#\< comment tags document something designated by the location of the comment. In general, the comment documents the previous symbol. A comment will not be associated with any parse id that does not have the same parent as the comment. For example,

Usage

pd_get_relative_comment_associated_ids(id, pd, .check = TRUE)

Arguments

id

id of the expression of interest

pd

The parse-data information

.check

Perform checks for input validation?

Value

Returns a vector of the same length as id. Where the value is either the id of the associated object or NA if it cannot be associated.

Details

function(x #< a valid comment )

would associate a valid comment with x, but

function(x) #< not a valid comment

would not.