Re: Ideas for documentation improvements

Larry Evans <[email protected]> Thu, 18 Jul 2019 10:35:25 -0500
Newsgroups gmane.comp.parsers.spirit.general
Message-ID <[email protected]>
On 7/18/19 9:19 AM, Maarten Verhage wrote:
> Dear Spirit mailing list members,
> 
> On the boost developers mailing list I wrote a message titled “Something off 
> my chest about Boost” in which I shared my frustration about Boost library 
> documentation. As well as some concrete suggestions. I admit the 
> frustrations and suggestions where mainly for Spirit X3.
[snip]
> 1) Parser synthesized attribute, is a vague term. To make it tangible you 
> can say that the parser is internally working with adjusting iterator 
> positions that attempts to match PEG expressions and when it finds a match 
> it can call std::string( InputIt first, InputIt last ) for example. Then in 
> the semantic action _attr( ctx ) is what we call an attribute. In this case 
> a std::string.
> 
> 2) Even so is rule synthesized attribute. Better is to say part of the 
> datastructure where the parsed data needs to be assigned to. Maybe this is 
> not true in a general sense but you give the readers something tangible.
> 

The term "synthesized attribute" is well understood in attribute grammar
circles.  Basically, the synthesized attribute of X is a function
of the attributes of the children of X in the parse tree.

At least that's what:

  https://en.wikipedia.org/wiki/Attribute_grammar#Synthesized_attributes

and that's how it's been described in many C.S. articles and books.