farice9 / pe

0 stars 0 forks source link

Confusing parameter introduction for mandatory and optional fields #10

Open farice9 opened 4 years ago

farice9 commented 4 years ago

image.png

I found it confusing when reading this sentence. For example, I don't know what is mandatory? Whether it is the item in the <> or the "<>" itself. It might better if it is phrased as "items in angle brackets () are mandatory instead. The same goes to optional.

nus-pe-bot commented 4 years ago

Team's Response

Hi, thank you for the feedback, we acknowledge this bug but have decided to lower its severity as it is mainly a grammar issue for this sentence, the usage of angle brackets in the documentation is further elaborated in the example following the sentence. We will change it to what you have recommended.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]