victorouy / pe

0 stars 0 forks source link

Long outputs for simple list commands in UG #7

Open victorouy opened 1 year ago

victorouy commented 1 year ago

There are unnecessarily long output examples for the list commands of priority_list(listing all tasks arranged by priority) and list_today (Listing all tasks and classes happening today). Additionally, the help command which is quite straight forward has an long output that fills up space unnecessarily.

image.png

image.png

nus-pe-bot commented 1 year ago

Team's Response

We wanted to make the UG comprehensive for every feature. we felt that we should be thorough in explaining all the different functions in the program.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I understand that you wanted to make the user guide comprehensive for every feature, but it's important to remember that users may not have the time or patience to read through long output examples and descriptions for every function. It's crucial to strike a balance between providing enough information to guide users through the program and overwhelming them with excessive details.


## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]