amzhy / pe

0 stars 0 forks source link

Inconsistent format for parameter descriptors #18

Open amzhy opened 3 years ago

amzhy commented 3 years ago

image.png

PATIENT_INDEX is shown in code, but used as plain text in tip. This is inconsistent, users might find it hard to differentiate parameter descriptors from plain text

nus-pe-bot commented 3 years ago

Team's Response

The message is still delivered and it does not affect the cosmetic or the functionality of the examples, hence it does not hamper the understanding of the readers at all.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: As mentioned in the website, it does not affect functionality or the usage - but it is a cosmetic issue due to inconsistencies which do not seem intentional in the user guide.

image.png


:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]