jaredtengsw / pe

0 stars 0 forks source link

Examples for edit function in command summary table is lacking #12

Open jaredtengsw opened 3 years ago

jaredtengsw commented 3 years ago

In the command summary table, the developer team only listed an example where edit function is shown to be used to edit 1 attribute of task only. Developer team can consider adding another example to show that multiple attributes can be edited at once using the function as well.

image.png

nus-pe-bot commented 3 years ago

Team's Response

As the name suggests, the command summary table is meant to be a summary. For more examples the user should refer directly to the edit feature section.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I disagree with the developer's stance on this issue. As much as the command summary table is meant to be a summary, I believe that for new users who are trying to learn and familiarise themselves with the commands, it would be more logical and common that they would refer directly to the command summary table since all the commands are displayed there. If a user has to go specifically to the feature section just for more examples on an additional way to use a function for the reason that it is not shown in the command summary table, it would pose an inconvenience to users.