simbayippy / pe

0 stars 0 forks source link

Diagram not updated in DG #14

Open simbayippy opened 11 months ago

simbayippy commented 11 months ago

The following diagram is not updated to include the details of: student Number, GPA, comments etc, and still contains AB3 contents of address/email etc. This may lead to confusion from the following developers perspective as they may not understand what they refer to. As it as a flaw that causes occasional inconvenience to some users (developers) but they can continue to use the product, giving it a medium severity

Screenshot 2023-11-17 at 5.15.55 PM.png

similarly for:

Screenshot 2023-11-17 at 5.18.31 PM.png

nus-pe-bot commented 11 months ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Image not rendered in DG

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.


The following image is not rendered in the DG, making it hard to understand exactly what this is about, hence giving it a low severity as it may actually hinder a readers understanding of what it does

Screenshot 2023-11-17 at 5.19.22 PM.png


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

Their Response to the 'Original' Bug

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

Very low as other diagrams are still present for the same function, hence understanding is not too hindered.

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: These are not duplicates of each other. The original bug is one where the diagram is missing, but this particular bug is for the contents in another diagram not being updated, containing AB3 data.


## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** a `VeryLow` severity as according to cs2103t website is: A flaw that is purely cosmetic and does not affect usage e.g., a typo/spacing/layout/color/font issues in the docs or the UI that doesn't affect usage. Only cosmetic problems should have this label. Evidently this does affect usage as its more than the aforementioned description, and this is not **just** a cosmetic problem. Its missing updated information about the software, and relevant classes for it, and leaving redundant information such as "address" that is never used in the software. Hence severity should still be `Low`