lestersimjj / pe

0 stars 0 forks source link

Correction to format for add command in UG #9

Open lestersimjj opened 2 years ago

lestersimjj commented 2 years ago

Describe the bug
There is a backtick missing for the type argument in the UG for add command.

Expected

Format: add n/`ITEM_NAME` s/`SERIAL_NUMBER` t/`TYPE` c/COST` pf/`PURCHASED_FROM` pd/`PURCHASED_DATE`

Actual

Format: add n/`ITEM_NAME` s/`SERIAL_NUMBER` t/`TYPE c/COST` pf/`PURCHASED_FROM` pd/`PURCHASED_DATE`

Screenshots
image.png

nus-se-script commented 2 years ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Format of the add command wrongly demonstrated in UG

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.


Format of the add command in UG is without backtick after type and before cost, as follows,

add n/`ITEM_NAME` s/`SERIAL_NUMBER` t/`TYPE c/COST` pf/`PURCHASED_FROM` pd/`PURCHASED_DATE`

It contradict with the example given just below the format in UG,

add n/`SpeakerB` s/`S1404115ASF` t/`Speaker` c/`1000` pf/`Loud_Technologies` pd/`2022-02-23`

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

Their Response to the 'Original' Bug

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

This was a typo. Thank you for bringing it to our attention.

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 severity

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

Reason for disagreement: [replace this with your explanation]