jaejayrome / pe

0 stars 0 forks source link

Find Command Use Case is misleading in the UG #8

Open jaejayrome opened 6 months ago

jaejayrome commented 6 months ago

Description: UG is misleading 'find' command is for 'finding students' but end up I am able to find parents as well.

Screenshot 2024-04-19 at 4.45.33 PM.png

Screenshot 2024-04-19 at 4.45.43 PM.png

Suggestions: Be more explicit and mention find command is not only for students in the UG

nus-pe-bot commented 6 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 Header Misleading Use Case

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.


Description: Suspect documentation bug here because the header mentions "find: find students" but this has been applied to include parents as well. The paragraph beneath it extends it to "persons", a more general term.

Screenshot 2024-04-19 at 5.14.41 PM.png

Suggestion: Change the header


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

Their Response to the 'Original' Bug

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

No details provided by team.

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]