search

DrWala / pe

0 stars 0 forks source link

Incorrect link in DG (MainWindow.fxml, Page 5) #15

Open DrWala opened 3 years ago

DrWala commented 3 years ago

What is the issue

Link to MainWindow.fxml on page 5 of DG links to SE-EDU instead of the team's project

Why it matters

The user should be directed to code belonging to the project itself, not the underlying SE-EDU project.

Severity justification

Low because it will cause a minor inconvenience to developers trying to understand the project, not VeryLow as its not purely a cosmetic issue.

nus-pe-bot commented 3 years ago

Team's Response

No response provided.

The 'Original' Bug

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

Incorrect link in DG (Storage, Page 9)

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.

What is the issue

Link to Storage.java on page 9 of DG links to SE-EDU instead of the team's project

Why it matters

The user should be directed to code belonging to the project itself, not the underlying SE-EDU project.

Severity justification

Low because it will cause a minor inconvenience to developers trying to understand the project, not VeryLow as its not purely a cosmetic issue.

[original: nus-cs2103-AY2021S2/pe-interim#488] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

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

No details provided by team.

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: As confirmed by Prof during the PE itself, this is not a duplicate issue. Separate broken links are separate issues.

image.png

:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.Low]

Reason for disagreement: Here is the textbook definition of "severity":

image.png

This is not a cosmetic issue, text layout issue, or colour issue. It's an invalid link to pointing to a project that is not about the product and affects the reader when they attempt further understand the product by clicking the link. Therefore, it should be "low".