search

nus-tic4002-AY2122S2 / pe-dev-response

0 stars 0 forks source link

In UG, inconsistencies of index keyword used in Command Summary and Command corresponding to Feature sections #259

Open nus-se-bot opened 2 years ago

nus-se-bot commented 2 years ago

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

In Command Summary section, index is referred to as "INDEX" but it is referred to as "SEQ_NO_OF_CONTACT" in the Command corresponding to Feature section.

The term should be consistent to avoid confusion

[original: nus-tic4002-AY2122s2/pe-interim#253] [original labels: severity.Low type.DocumentationBug]

chenghuiyuan commented 2 years ago

Team's Response

It is understandable that SEQ_NO_OF_CONTACT is referring to INDEX since command examples are given.

Duplicate status (if any):

--