search

germainelee02 / pe

0 stars 0 forks source link

Inconsistent naming convention #21

Open germainelee02 opened 1 year ago

germainelee02 commented 1 year ago

Inconsistent naming convention for removepj and editpj. Why are there so many square brackets?

Screenshot 2023-04-14 at 3.19.22 PM.png

soc-se-bot commented 1 year ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Very confusing way of writing command format

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

So many unnecessary square brackets. Makes it confusing for first time users.

Screenshot 2023-04-14 at 3.17.26 PM.png

[original: nus-cs2103-AY2223S2/pe-interim#3118] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

This format is covered extensively in "Notes about the command format" under "Features". As such, the reported DocumentationBug is invalid, as the square brackets are not unnecessary, and indicate a different behavior. Do refer to the screenshot below for the relevant section:

image.png

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]

## :question: Issue response Team chose [`response.Rejected`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]