Open jannaleong opened 4 months ago
Both talks about Main app link in DG.
[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.
[original: nus-cs2103-AY2324S2/pe-interim#4420] [original labels: severity.Medium type.DocumentationBug]
[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.
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.