search

ngkaiwen123 / pe

0 stars 0 forks source link

Line separators needed to increase readeability #5

Open ngkaiwen123 opened 1 year ago

ngkaiwen123 commented 1 year ago

Screenshot (477).png

Lack of line separators followed by large chunks of text makes it hard for the user.

image.png

nus-se-bot commented 1 year ago

Team's Response

How many line separators do you see in that screenshot you gave? 12. And that takes up 30% of the total lines in the command line output. You want more? Then you're going to complain about too many line separators that make it hard to read.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Hard to read display message

Program does not give the clear difference between user's input and the program output. It can lead to confusion and hard to read message. The program should be give the clear difference (for example, program output is indendted/after line)

image.png

[original: nus-cs2113-AY2223S2/pe-interim#2551] [original labels: type.FunctionalityBug severity.Low]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

We apologise for the inconvenience caused. Our group has tried to make the output readable by placing line separator while also not cluttering the output with too many of them. We believe that this is subjective from user to user and that some users may find this separation for each command suitable.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]

## :question: Issue response Team chose [`response.NotInScope`] - [x] I disagree **Reason for disagreement:** In the reasoning by the group in the duplicate bug, they have indeed acknowledged that it is something that could be improved on. Line separators help the users identify between the different outputs and inputs of the program. I acknowledge that my screenshots are not a prime example, but the screenshots as shown in the duplicate are ideal in showing why line separators are necessary and not simply labeled as "out of scope", just because it is not mentioned in their value proposition or user stories. The aggressiveness in the team's response to the bug is also very much unnecessary and unappreciated. ``` How many line separators do you see in that screenshot you gave? 12. And that takes up 30% of the total lines in the command line output. You want more? Then you're going to complain about too many line separators that make it hard to read. ``` Line separators are not the only way to increase readability. A table for the diagnosis output can also help, if the group claimed that "users may complain about having too many line separators".
## :question: Issue type Team chose [`type.FeatureFlaw`] Originally [`type.FunctionalityBug`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]
## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** There are minor inconveniences as a result of inconsistencies in the placement of line separators. This is not something as trivial as, say, a mispelled word. Users will have a hard time identifying between the different sections of the program, and thought that a group of strings are a result of the same input, rather than due to a different input. `severity.Low` is a more appropriate severity level for this bug.