search

nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

[DG] Hyperlinks Do Not Lead to the Correct Destinations #3633

Open nus-se-script opened 1 week ago

nus-se-script commented 1 week ago

Currently, under the UI component of the DG, the clickable links MainWindow and MainWindow.fxml does not lead me to TrackMate's source code. Instead it brings me to AB3's source code, and thus it does not match the UML diagram for the UI component which is misleading.

image.png

Moreover, the link given for the Storage Component API Storage.java also leads me to AB3 source code instead which does not align with how TrackMate handles their Storage given that the UML diagram has extra components not found within AB3. Thus, this is also misleading.

image.png

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

waihongteh commented 6 days ago

Team's Response

Our team does agree that this is a documentation bug. However, our team does not think that this is a severity medium label, but rather a severity low label. Here's why:

As what being stated in CS2103T website, "Broken/incorrect links: Severity can be Low or Medium depending on how much inconvenience they cause to the reader."

This incorrect links for Storage.java and MainWindows.java do not cause much inconvenience to the users, as the explanation within the developer guide is comprehensive enough for the users to understand. The links rather work as an add-on if the users are keen to find out more. So it might cause slight inconvenience, but definitely not a huge inconvenience.

Duplicate status (if any):

--