search

geraldneo567 / pe

0 stars 0 forks source link

Extraneous space in app command example in UG #20

Open geraldneo567 opened 2 years ago

geraldneo567 commented 2 years ago

Not sure if this is intentional, extra space as circled in screenshot. (UG)

image.png

nus-pe-bot commented 2 years ago

Team's Response

It is intentional. To show that it will work even with the extra space.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: It is hard to see that it is intentional if every other command shown in the UG does not have an extra space for its CliSyntax prefixes. Furthermore the extra space means the string is actually different, i.e. "NUS Vet Clinic" vs "NUS Vet Clinic" (where the is a space) which may cause duplicates/discrepancies, such as when saving to JSON.

As attached in this screenshot, even the given format for this command does not include the space. So this is clearly an unintentional oversight which may unnecessarily confuse readers and therefore should not be rejected.

image.png

Additionally in the command summary, the example given does not have a space (highlighted with the red line for clarity).

image.png

3 more examples are shown from the DG where the command is used without a space.

image.png

Therefore this is clearly a typo, and if it was really to show that it would work with the extra space then shouldn't the team mention it in the UG?