search

jannaleong / pe

0 stars 0 forks source link

MainApp link in DG brings me to incorrect github page #13

Open jannaleong opened 4 months ago

jannaleong commented 4 months ago

Upon clicking the mainApp link, I expect that it will lead me to their projects code for the mainApp component. However, it brings me to the AB3 code for the MainApp class.

This is problematic as the mainApp class in ab3 is not the mainApp class in their project. This will confuse readers.

image.png

nus-se-script commented 4 months ago

Team's Response

Both talks about Main app link in DG.

The 'Original' Bug

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

Main app link in DG does not bring me to the correct link

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.

Upon clicking the main link, I expect that it will lead me to their projects code for the main component. However, it brings me to the AB3 code for the Main class.

This is problematic as the main class in ab3 is not the main class in their project. This will confuse readers.

image.png

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

Their Response to the 'Original' Bug

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

Thank you for pointing this out. We did overlook that. We accept it as severity-low as the reader's understanding is still largely aided by the architecture diagrams, and it affects rare instances where the reader refer to only the linked classes. In that case, given that the implementation did not change from AB3, this is likely to cause minor inconvenience only.

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: I apologise for my typo in the title of bug report #12. When i was typing quickly during the practical, instead of typing "main" i typed "main app". However, if you look at the contents of bug report 12, it is clear than i am talking about the Main class link while in this bug report 13, i am referring to the MainApp class link.

In bug report 12, the term Main class and Main is repeated throughout the bug report while in bug report 13, the term mainApp class and mainApp is repeated throughout the bug report. Other than the clear typo in the title of bug report 12 (as there is no class called "main app" with a space between "main" and "app"), it is clear that these reports refer to different links in the dg.

Now, to qualify as a bug being a duplicate the tp guidelines state that it must either be exactly the same bug OR the buggy behaviour is caused by the same defect and cannot be fixed independently.

Firstly, from the above explanation, bug 12 and bug 13 while similar, are not exactly the same bug. They refer to different links, namely the Main class link vs the MainApp class link. Secondly, the buggy behaviour requires independent fixes. fixing the incorrect link for the MainApp class in bug 13 will not automatically fix the incorrect link for the Main class in bug 12.

Thus, it does not fall under either case and is not a duplicate bug.

## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** Following tp guidelines, to qualify as a low severity bug, the flaw must "Appears only in very rare situations" and causes "a minor inconvenience only". On the other hand, for a medium severity bug, the flaw "affects some users" and "causes occasional inconvenience". We see these different severities differ in the frequency of the bug experienced by users and the inconvenience it causes users. As future developers are reading your dg, they come in with the intention to understand your product in order to develop it further. To understand it, it is logical to want to look at your implementation and click the link that you have provided. (After all, that was the reason why you attempted to link the "MainApp" phrase to the MainApp class code in your repository in the first place). Understanding this, as these developers try to understand your product, it is natural for them to click this incorrect link. This is not a "very rare situation". Instead at least some users will click this incorrect link and this bug will "affect some users". Thus based on frequency of the bug experienced, it is falls under medium severity. Moreover, this bug does not cause "a minor inconvenience" as the inconvenience is significant. The link points to a completely different repository. Yes, you have argued that the code is exactly the same currently. However, as you are not the authors of AB3, the mainApp class code in AB3 can be easily updated by its authors. There can easily be differences between the AB3 mainApp code and your code. If users do not notice this, they would be understanding code unrelated to your product which is more than a minor inconvenience. It would waste their time and effort as after understanding irrelevant code, they may not have gained knowledge about your existing implementation. It would be an "occasional inconvenience" experienced by users who click your link. Thus, on the basis of inconvenience caused, it is a medium severity bug.