search

dendendenden04 / pe

0 stars 0 forks source link

Find deadline lacks description on what it needs to do #15

Open dendendenden04 opened 1 year ago

dendendenden04 commented 1 year ago

image.png

Users may be left to second-guess what keyword here is. Perhaps adding a description of the function will help users who are using the guide?

nus-pe-script commented 1 year ago

Team's Response

This issue is similar to #1743 where it mentions the lack of description of what is a keyword

The 'Original' Bug

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

Unsure what the parameter of this find_* function is supposed to be based on 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.

Screenshot 2023-04-14 at 5.26.21 PM.png

Does this keyword represent the full name of a deadline/ or a part of it? or can i use the time as a keyword? Just from reading this part of the UG all these are uncertain. The keywords for most of the other find_* commands have this issue as well..

[original: nus-cs2113-AY2223S2/pe-interim#1371] [original labels: severity.Medium type.DocumentationBug]

Their Response to the 'Original' Bug

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

find_dish has defined what exactly the keyword is and that it is used to search for any substring in name of the dish that contains that keyword. This is seen on the first image below. find_meeting also mentions about using the name as the keyword. This is seen on the second image.

image.png

image.png

However, our team understands that the description for find_deadline and find_staff was not detailed enough in explaining the keyword portion.

However, we believe that the severity should be lowered to Low because we did mention about the definition of keyword in the other find commands which the user can infer from. Hence, after lowering the severity, our team decided to accept this as a DocumentationBug

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]