ruijietay / pe

0 stars 0 forks source link

Lack of screenshots and/or expected command outputs in UG #9

Open ruijietay opened 2 months ago

ruijietay commented 2 months ago

Although there are some screenshots in the quick start and FAQ, there doesn't seem to be any screenshots in the commands section, as well as the expected command output I should see when I input the example commands in the UG (or any other valid commands).

nus-pe-script commented 2 months ago

Team's Response

The text given is quite clear about what the user should see. Hence, this issue is not as important as the work already done in v1.4.

The 'Original' Bug

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

Lack of visuals for edit command 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.


Overview The edit command has a big caution in the UG for editing subject and tag. However, this part should be supplemented with visual for extra clarity (rather than just typing text out as it does not correctly mimic actual app).

Screenshot

Screenshot 2024-04-19 at 5.23.01 PM.png


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

Their Response to the 'Original' Bug

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

The text is already quite clear about what will happen when editing subject and tag. Hence, fixing this issue is not as important as the work already done in v1.4.

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.NotInScope`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]
## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.VeryLow`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]