LWS49 / pe

0 stars 0 forks source link

Edit uses add as an example #2

Open LWS49 opened 2 months ago

LWS49 commented 2 months ago

image.png This screenshot is taken from the 'edit' section of the page, but are invalid 'add' commands.

soc-se-bot commented 2 months ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Edit command description in UG has examples of add 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.


image.png

image.png

As seen in the image, the portions on invalid height and weight inputs have add as the command. I understand what is being implied, but it still threw me off initially - might be more prudent to use the edit command in the example as it is in the edit command section.


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

Their Response to the 'Original' Bug

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

The message to be conveyed is clear, but we could have definitely been more careful in the type of command used.

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]