Eclipse-Dominator / pe

0 stars 0 forks source link

Confusing use of monospaced 'code fonts' in user guide #8

Open Eclipse-Dominator opened 1 year ago

Eclipse-Dominator commented 1 year ago

image.png

Based on these photos, a regular user would assume monospaced text such as this will be referenced to command-related details. However, as seen from various locations such as in the screenshot below. nusmod is also shown using a monospace font which is very confusing for the users as nusmod is not really a command to add and there are no explicit or clear explanation to what the monospace fonted text actually mean.

image.png

nus-pe-script commented 1 year ago

Team's Response

We don't think that monospace fonts have a set meaning or defintion to it, instead it is merely a formatting style to make things clearer (in some sense due to the even spacings). Granted that perhaps we could not use monospace fonts for product title but I do not think this should be accepted as a bug as it is contingent one's formatting preference and style.

In this case, the context in which the monospace is used in is a clear indicator that it is not referring to a command.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your explanation]