search

dedsecrattle / pe

0 stars 0 forks source link

Formatting Errors in UG #16

Open dedsecrattle opened 2 months ago

dedsecrattle commented 2 months ago

image.png

Ug inconsistency in terms of format of examples provided used code blocks for some while some are given as plain text can cause confusion or misinterpretation for the user.

e.g delete 3 is formatted as a code block however exit and clear are plain text

nus-pe-bot commented 2 months ago

Team's Response

'clear' and 'exit' are indicating the format of respective commands, but not examples of respective commands. Thus, they are in plain text but not wrapped with ``, which is consistent with the format of command format representations for other commands.

image.png are in the same format as

image.png

Since both commands are trivial, we are not providing examples here.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your explanation]