search

choowengyan / pe

0 stars 0 forks source link

Invalid documentation format in DG #18

Open choowengyan opened 2 months ago

choowengyan commented 2 months ago

As shown in the screenshot below, test case 2 command line is not being formatted correctly. They should be quoted as code instead.

Screenshot 2024-04-19 at 5.38.30 PM.png

nus-pe-script commented 2 months ago

Team's Response

We do not believe that this would "Hinder" the reader in understanding and hence this is NotInScope

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: [I believe this hinders the reader readability and understanding as shown in the DG screenshot above, the test case addMeeting clientIndex/1 dt/02-01-2030 12:00 d/sian life plan is actually a command line. In fact, if the reader wish to copy and paste it to the program and he/ she does not notice the command line properly, he/ she might include the single quote "`" in the command and resulting error in the app.

Thus, I believe that formatting the test case examples correctly is essential to improve reader's understanding and avoid confusion. Actual: Screenshot 2024-04-23 at 1.28.19 PM.png

Expected:

  1. Test case: addMeeting clientIndex/1 dt/02-01-2030 12:00 d/sian life plan ]