search

gerardstevan / pe

0 stars 0 forks source link

UG example command throws an error message when copy then entered on the app #3

Open gerardstevan opened 1 year ago

gerardstevan commented 1 year ago

image.png

image.png

nus-pe-bot commented 1 year ago

Team's Response

First of all, we have given the valid format specified in the UG for you to use. Second of all, we have given you examples to use. However, due to the line breaks, raw copying and pasting might have discrepancies that you, the user, may have to rectify yourself. There should not be an expectation that raw copying and pasting of the examples are guaranteed to work nor did we condone it ourselves. This should be clear.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: So, this is a problem with a line break or missing spaces in their UG, and I believe I don't have any obligation to rectify the dev team's mistake.

This is the example they gave in their UG. I believe an example exists and is given to be either followed or not (It depends on what the description says), so when I want to try the example given by the dev team in the user guide, naturally I expect it to be correct (unless stated otherwise, which they didn't state explicitly as said in their argument).

This should be counted as a cosmetic error towards you UG, thus, documentation bug, very low level