search

joshuan98 / pe

0 stars 0 forks source link

Unsure of how to use add command #6

Open joshuan98 opened 1 year ago

joshuan98 commented 1 year ago

A first time user who has not read the user guide might be unsure of whether the [] are required for the add command.

image.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]

Brackets for command

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.

The ug can specify that the brackets should be removed when typing in the module code.

image.png

Inform the user to type add CS2113 instead of add [ CS2113 ]

[original: nus-cs2113-AY2223S1/pe-interim#133] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

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

User guide states,

image.png

Help command also states,

image.png

Furthermore, examples are provided for each command.

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]

Reason for disagreement: [replace this with your explanation]

:question: Issue type

Team chose [type.DocumentationBug] Originally [type.FeatureFlaw]

Reason for disagreement: [replace this with your explanation]