Yufannnn / CS2103T-Practical-Exam

0 stars 0 forks source link

No Example Commands Given for many Commands in the UG #22

Open Yufannnn opened 1 year ago

Yufannnn commented 1 year ago

Examples of commands are given for most of the commands in the UG.

Screenshot 2023-04-14 152851.png

However, as far as I can find, checkout, and overview doesn't have examples. This affects new users who want to quickly try the commands and also results in inconsistency.

nus-pe-bot commented 1 year ago

Team's Response

image.png

The example commands were given under command summary, which came before the individual commands' explanation. For simple commands like these which only required a single input, There does not seem to be a point in repeating, especially since the application's target audience is for adults working in NEA.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I understand that it is given in the command summary table, but I want to point out that some commands did not give sample commands in the command explanation while some did. Your Team claimed that There does not seem to be a point in repeating, especially since the application's target audience is for adults working in NEA. However, if we follow this logic, why do other commands provide sample commands in both places then? What is the criterion of distinguishing simple command?Therefore, I disagree with the explanation as the main issue here is the inconsistency between commands in the command explanation.