get_description: Gets a description of a given rule

In mslegrand/pegr: PEG PARSER

Description

Descriptions are like comments for rules, it is a good practice to comment your rules after you add them. See set_description

Usage

get_description(pegR, rule.id)

Arguments

rule.id,	a character string naming the rule
parser,	a peg parser produced by new.parser

Value

description, a character string describing the parser

Examples

pegR<-new.parser()
peg<-add_rule(pegR, "A<-'a'")
pegR<-set_description(pegR, "A", "recognizes 'a'")
get_description(pegR, "A")

mslegrand/pegr documentation built on May 23, 2019, 7:53 a.m.