ChewyChair / pe

0 stars 0 forks source link

Misleading command syntax for module command #15

Open ChewyChair opened 2 years ago

ChewyChair commented 2 years ago

Command syntax is given as module {module code:{class number,}...;}... but perhaps {module code:{class number,...}};... would be more correct?

image.png

nus-pe-bot commented 2 years ago

Team's Response

... means "one or more of the previous entity". Since the separator is part of the entity, it makes more sense to keep it within the entity, not outside. Otherwise, it could be misunderstood as "the separator itself being repeated multiple times".

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I don't quite understand this.

image.png

(Taken from Wikipedia)

In common mathematical notations, ... is used after mathematical operators, yet there is no misunderstanding on whether the "mathematical operators themselves are repeated multiple times".

Furthermore, {class number,...} is in my opinion, easily understood as an array of class numbers, but {class number,}... is not.

This notation seems pretty misleading on my end as users might struggle to understand the command syntax. At least, I did.