search

mrweikiat / pe

0 stars 0 forks source link

Documentation Bug : Neatness and correctness #3

Open mrweikiat opened 3 years ago

mrweikiat commented 3 years ago

Some line spacings are off for the UG, causing minor incorrectness in presentation

image.png

image.png

Expected:

image.png

This is a good example of properly spaced instructions in a table, this is very clear and specific on how the users can use certain commands

nus-pe-bot commented 3 years ago

Team's Response

This is due to the limitations of the table function of github markdown which is out of our control. However, if you look carefully at the code block you can see that the lack of spacing at the end of "--" and before "birthday" indicates that the code is wrapped to the next line.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your reason]

:question: Issue severity

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

Reason for disagreement: [replace this with your reason]