search

nus-cs2103-AY1920S2 / pe-dev-response

0 stars 0 forks source link

Symbol errors in multiple fields. #2602

Open nus-pe-bot opened 4 years ago

nus-pe-bot commented 4 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.

m/ parameter can be specified multiple times. However, it is not marked as m/[MEMBER_IDS]... (Notice the ...) as specified in section 3. This may confuses the user.

5.jpg

[original: nus-cs2103-AY1920S2/pe-interim#2601]

raivatshah commented 4 years ago

Team's Response

This is a valid issue. However, we disagree with the severity as "High" because although there's the mistake in the format specification, the 3 examples that follow immediately are sufficient to cover all scenarios (Editing more than one member, editing one member, or not editing at all). This minor typo is not "A flaw that affects most users and causes major problems for users. i.e., makes the product almost unusable for most users." (referring to the module website).

Given that we have sufficient examples and we clearly state in words "Either a new name or new member(s) is required to edit the group" (immediately before the examples and below the typo), we feel that the severity of this issue is low at best.

Duplicate status (if any):

--