set_description: Attach an (optional) description to a specified rule

Description Usage Arguments Examples

View source: R/set_description.R

Description

A description should be used to comment a given rule

Usage

1
set_description(pegR, rule.id, description)

Arguments

parser,

a peg parser produced by new.parser

rule.id,

a character string naming the rule

description,

a text string describing the rule

Examples

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

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