search

jaredlhf / pe

0 stars 0 forks source link

Not well formatted #8

Open jaredlhf opened 2 years ago

jaredlhf commented 2 years ago

Screenshot 2021-11-12 at 5.39.04 PM.png Screenshot 2021-11-12 at 5.39.33 PM.png

Looks messy, could possibly put in a table format

nus-pe-bot commented 2 years ago

Team's Response

A summary table is already provided at the bottom. Commands have varying amount of information and certain commands will be more detailed that others.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: This is a subjective issue, however, as a reader, I found it hard to read an entire chunk of text below each command. This is made worse when parameter constraints explanations are jumbled with other forms of information (such as information relating to command format) when splitting them up would have made them easier to read.

The point regarding formatting it in a table format is with regards to the information in the chunk of text, referring to the summary table would not be helpful if I have troubles with the parameter constraints. However, putting the information in a table (or other better structure or format) would have made the text easier to read.