brein62 / pe

0 stars 0 forks source link

FindCommand in logic class diagram but not used in app #10

Open brein62 opened 11 months ago

brein62 commented 11 months ago

Not a huge issue, but given that the FindCommand isn't really stated anywhere in the UG, although it is present in the code (but not in functionality of the final product), it would be nice to use a different command as an example to be used in XYZCommand.

Screenshot 2023-11-17 at 5.18.13 PM.png

soc-pe-bot commented 11 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]

Find command exists but is not documented in the 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.


Able to search for charlotte using find charlotte image.png

This functionality is included in the user story in the DG and seems like a core feature that will bring additional value to users.

However, user will not know the existence of this functionality as it is not found anywhere in the UG.


[original: nus-cs2103-AY2324S1/pe-interim#3461] [original labels: type.DocumentationBug severity.Medium]

Their Response to the 'Original' Bug

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

Although we did not formally explain find, we did include it in some examples, e.g. the delete command example. Thus, it probably would not affect use of the app severely enough for it to be Medium, and we feel like it is a low severity bug.

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]