ISSUE 40

Number 40
Category errata
Synopsis Misleading comment in example in 4.4.3
State lrmdraft
Class errata-simple
Arrival-DateOct 07 2001
Originator Shalom.Bresticker@motorola.com
Release 2001b, 4.4.3
Environment

Description

Date:
Thu, 15 Mar 2001 16:25:55 +0200


In the example of section 4.4.3 (self-determined expressions), the following appears:

c = {a**b} ; // expression a**b is self determined
$display( ...) ; // due to {}

The comment on the second line is a continuation of the comment of the first line, but looks like it is a comment on
the second line. Worse, the comment on the first line looks self-contained, since it is a complete sentence,
so the reader does not associate the next line comment with it.

You might say that's not reasonable, but it is a fact that it confused me, and it took me a long time to understand
by a**b is self-determined.

It should be

c = {a**b} ; // expression a**b is self determined due to {}
$display(...) ;

------------------------

Note: David Knapp suggested modifying comment to read
"expression a**b is self determined due to concatenation operator {}"
In any case, comment should not be on same line as "$display".
Fix
Passed 10/7/02:

Section 4.4.3 example:

REPLACE:
c = {a**b};              // expression a**b is self determined
$display ("a**b=%x", c); // due to {}


WITH:
c = {a**b}; // expression a**b is self determined
            // due to concatenation operator {}
$display ("a**b=%x", c); 


NOTE TO EDITOR: Keep $display on line after comment regarding
"concatenation operator {}"

Audit-Trail
Unformatted


Hosted by Boyd Technology