search

kahhe / pe

Repo for potential bugs I found for CS2113T Practical Exam
0 stars 0 forks source link

Not using line breaks in printed text #6

Open kahhe opened 2 years ago

kahhe commented 2 years ago

Text in app does not use line breaks. Where one sentence ends is at the whims of the width of the terminal window. Some words get cut of and is harder to read.

Severity is medium because it happens in many (if not all) texts.

image.png

This occurs to text-generated "images". (supposed to spell "Hang Man".)

image.png

nus-se-bot commented 2 years ago

Team's Response

Hi, Thank you for your advice. The reasons are

  1. it is only 89 characters per line which does not exceed the requirement of 140 characters. ( do have line breaker)
  2. Also, the problem with "Hangman" can not be reproduced from my computer.
  3. In addition, if we private the breaker in many words, it is also very inconvenient for users who use the large terminal window because there is only a few number of words per line.

Additionally, this problem can be solved by making the window larger.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Thanks for the detailed response!

I was suggesting using line breaks such as lineSeperator() or \n in a String to print String on a new line.
This will allow the text to generate more suitably for a smaller terminal, so when it does cut off, it won't be the problem of the code,
but rather the user has their terminal window too small.

Even in full screen the text is still being cut off:

image.png

In order to read the line without the width of the terminal affecting the printing, is to reduce the text to a smaller size:

image.png

In response to Reason 3:
If you have observed many news articles, they often don't stretch from the left to the right of the window, often they are a narrow strip of words in the middle of the browser,
with loads of unused space on the left and right (which is taken up by advertisements.) Newspapers do the same thing.
It's because it is harder on the human eye to track a single sentence laterally and finding which is the next line to jump to.
It will be beneficial to users if the lines were short and truncated intentionally in code.

But the hang man one was pretty nonsensical, forgive me for writing that. Of course it will show up weird if I squish my window into a small size.

:question: Issue severity

Team chose [severity.Low] Originally [severity.Medium]

Reason for disagreement: [replace this with your explanation]