search

ChewyChair / pe

0 stars 0 forks source link

[Improvement] More Intuitive Help Display #3

Open ChewyChair opened 2 years ago

ChewyChair commented 2 years ago

Perhaps the help command could display a table instead, like the UserGuide, as that would make it more readable.

image.png

nus-pe-bot commented 2 years ago

Team's Response

Unlike the website where CSS and HTML dictates a wholesome layout scheme, there is no such luxury in the terminal territory. Underlying ways to manipulate terminals are very platform-dependent and defeat the objective of being platform-independent. There are things like ANSI escape sequences that are relatively portable, but even on the same platform, different behaviour can be observed e.g. Windows Terminal vs PowerShell vs CMD, or Bash vs Zsh vs Fish. Even TAB, the primitive table creation code, can show up differently depending on the settings. Therefore, it is out of the scope of our CLI application.

The user is always welcome to view the user guide, either in PDF or HTML.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: It could have been formatted better even without a table, like so:

image.png

This would greatly increase readability. Also, if the user is expected to refer to the user guide, perhaps a link to the user guide could be provided in the help command as well for convenience.