cat command in UG is hard to read

[tanjiaxian99]

The cat command was rather confusing when I read the UG for the first time. Every command before cat has a clear command format on how to use the command. For cat however, there are 3 ways of using it, each with different flags and parameters. This makes the section rather confusing, and I took a bit of time to understand that cat is actually 3 commands merged into one.

It doesn't help that the numbering of the 3 ways is incorrect as well (Displays the task list of all persons in ContactSH should be number 3)

[nus-pe-bot]

Team's Response

We modelled this command similar to Linux CLIs (as we were catering to target users decent in such CLIs). In Linux, CLIs have commands like grep which have over 20 flags and can also have different parameter types, all of which causes different behaviours to the command grep.

Hence, it made sense for us to group all flags for cat under one section as putting these flags as standalone sections would most likely make it repetitive. Furthermore, we also made sure to separate these flags as distinct subsections 1, 2 and 3 with their own individual explanation, elaboration and examples so that users would be clear that they each have different behaviours/uses.

However, we do agree with you that due to HTML conversion issues, cat -A is incorrectly numbered as 1 and we gladly accept it as a cosmetic bug.

Items for the Tester to Verify

:question: Issue severity

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

• [ ] I disagree

Reason for disagreement: [replace this with your explanation]

---