lihka1202 / pe

0 stars 0 forks source link

Examples in the UG are not inline code, hence are hard to copy and paste #8

Open lihka1202 opened 1 year ago

lihka1202 commented 1 year ago

The examples for most of the features are pictures, which could be detrimental to users who probably would wish to copy and paste the code to try it out:

image.png

nus-se-bot commented 1 year ago

Team's Response

This is an aesthetics issue, as there are pros and cons.

Providing an exact screenshot of the terminal can be helpful to users as some users prefer to see a screen similar to what they will see during actual usage.

This is also a suggestion from our tutor from CS2101, who is an expert on User Guides with 8 years of teaching experience in CS2101.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: It is not a matter of whether the users see the same screen or not, my point lies with the fact that these are images and not snippets of code.

Users cannot copy code from images, but if blocks of code were to be used, then they would be able to copy the code and run it to see the result.

For reference this is what blocks of code means:

> add -out Haidilao $500

Users can copy this code, however users cannot copy and paste code from images

This is not merely an aesthetics issue,the lack of snippets of code reduces the functionality of the UG as a whole.


## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** Solely because this is not an issue pertaining to the aesthetics of the code