search

javinchua / pe

0 stars 0 forks source link

Inconsistency in formatting in UG #13

Open javinchua opened 9 months ago

javinchua commented 9 months ago

In the UG, some command formats include square brackets but some do not.

image.png

image.png The inconsistent use of square brackets can make users confused when following the user guide, and may inconvenient them in understanding how to use the application.

soc-se-bot commented 9 months ago

Team's Response

Please refer to here:

The square brackets are mean to specify optional parameters:

image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your explanation]

## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]