hiivan / pe

0 stars 0 forks source link

Random "!!" found in Developer Guide (Page 23) #5

Open hiivan opened 2 months ago

hiivan commented 2 months ago

In Page 23 of the Developer Guide, one of the steps states "1a1. User !!searches again (UC3)!!." Not too sure whether the inclusion of "!!" was a typo or some markdown error.

image.png

nus-se-script commented 2 months ago

Team's Response

This is a duplicate bug, the screenshot is the same.

The 'Original' Bug

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

Confusing use of "!!" in Delete and Edit contact MSS

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.


As seen from here, I am not sure what does !! mean there and I believe it might be a typo error.

Screenshot 2024-04-19 at 5.34.11 PM.png

Screenshot 2024-04-19 at 5.36.03 PM.png


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

Their Response to the 'Original' Bug

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

Thanks for catching this. As 2 of the same bug was put into 1 issue, we will be taking it as the top picture at UC6, found at page 25 of the DG.

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: Not too sure whether you are saying that it is the same bug as my other bug report (Random "!!" found in Developer Guide (Page 25)), or you are saying it is a duplicate bug to the 'Original' bug (which you have already stated that you are taking it as the typo found at page 25 of the DG, and not page 23). Either ways, it should not be classified as a duplicate bug, but a separate bug instead.

For the record, this particular screenshot was taken in Page 23 UC4 (as stated in the bug report title), whereas the other issue was taken in Page 25 UC6. Your DG has two of the same kind of typo bug, but they can still be considered as two separate bugs according to the tP: Practical Exam (PE) guidelines for bug triaging, where it states:

In real projects, similar bugs (e.g., the same typo in multiple places) tend to get combined into a single issue/PR; in the PE, we have to keep independently-fixable things as separate bugs, to avoid complications in grading. After all, having the same typo in two places is not exactly the same as having it in only one place. If an independently-fixable yet similar problem appears in more than five distinct places, get our permission to combine them as one bug (in which case we'll require you to increase the severity to match the frequency of the bug).

Hope this clarifies.