damiwee / pe

0 stars 0 forks source link

Code highlighting format #3

Open damiwee opened 4 months ago

damiwee commented 4 months ago

Code/ commands are recommended to be highlighted using <code> or <code> to signal to the reader and make it more readable.

from UG:

image.png

image.png

nus-se-script commented 4 months ago

Team's Response

This is already in code highlight format. It is how GitHub pages renders the page, and the PDFs submitted were created using the method recommended in the notes.

image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: This is a likely to be a pdf conversion error on the dev team's end. With reference to the the screenshot, which is a preview of the PDF conversion of the AB3 guide, it is seen that code sections retain their formatting. I have also added a preview of the pdf conversion for your own guides too. (the 2 screenshots are generated by me)

image.png

image.png


## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]