Mantis 3295 ___ Yes __ X__ No
http://www.verilog.org/mantis/view.php?id=3295
http://www.eda-stds.org/mantis/file_download.php?file_id=4860&type=bug
[Seligman, Erik] The concepts are great, but I think some editorial changes are needed to make this section clearer:
- At the start of 20.11 we mention $assertcontrol and then dive right into the details of the control_type arg. I think we should start with a high-level description of the purpose of assertcontrol, and a bulleted list with a high-level description of each arg & its type. Then the details of control_type can start in the 2nd paragraph.
- P.3, near start of 20.11-- I think 'expect' needs to be in courier in the text.
- Uses of 'i.e.'/'e.g.' at the start of a sentence or without any semicolon/comma before don't sound right; I think those sentences need rephrasing.
- Where we refer to raw numbers in the text, I think we should have a parenthesized reference to their symbolic meaning. (Except at the start of a bullet point where we have just given the meaning.) Otherwise it requires frequent manual back-referencing to tables. For example:
o Current: "Lock: A value of 1 for this argument shall maintain the same status of all specified assertions until a subsequent $assertcontrol with a control_type value of 2."
o Suggested: "Lock: A value of 1 for this argument shall maintain the same status of all specified assertions until a subsequent $assertcontrol with a control_type value of 2 (Unlock)."
- The extended code example is nice-but I think we should use full words in the symbol names (CONCURRENT, SIMPLE_IMMEDIATE, etc.) rather than truncated words (CONCUR, S_IMMED), to make the example more readable.
- Also in the example, when a comment extends >1 line, it might be nice for each line to have a // to improve readability.
-- This message has been scanned for viruses and dangerous content by MailScanner, and is believed to be clean.Received on Thu Apr 7 13:54:41 2011
This archive was generated by hypermail 2.1.8 : Thu Apr 07 2011 - 13:54:47 PDT