search

STELLA-LYE / pe

0 stars 0 forks source link

Add command examples standardisation with the actual command format #12

Open STELLA-LYE opened 7 months ago

STELLA-LYE commented 7 months ago

Screenshot 2024-04-19 at 5.30.28 PM.png

For the above image, it is mentioned in that the add command requires a space after the command flag. Eg /poc/ + +jane yeo`

Screenshot 2024-04-19 at 5.30.45 PM.png

However, for the examples provided above, there is a missing space between /poc and the name of the person.

This missing space can leave users confused on which command format is correct/incorrect as it is not mentioned specifically. Therefore, it can be more useful to edit the examples to contain the space so that the command format matches that as specified.

nus-se-script commented 7 months ago

Team's Response

image.png

We have specified for the users that copying the lines directly may break the spacing for the command at the start of Tutorial. The user is expected to add the spacing between lines if it is missing after copying and pasting.

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.Low`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]