Open xenthm opened 1 week ago
This issue is classified as Very Low severity because it is a purely cosmetic problem that does not affect functionality or the documentation's usability. The incorrect arrow notation in the UML diagram deviates from UML standards but does not hinder readers' ability to understand the relationship between the base and derived classes. While correcting the arrow to the proper UML inheritance style would align the diagram with standards, the current diagram is still clear and usable. Therefore, this issue fits the definition of a Very Low severity documentation bug.
Team chose [severity.VeryLow
]
Originally [severity.Low
]
Reason for disagreement: I disagree that the incorrect arrow notation is "purely a cosmetic problem". I argue that this notation will indeed hinder a reader's understanding of the affected classes, because the arrow used implies that the Expense
and Income
classes have a reference to FinancialEntry
abstract class (uni-directional navigability). This is most certainly not the case because the team mentions that this arrow could be corrected to the "proper UML inheritance style". Thus, this error is not just cosmetic, as it represents the actual structure of the code and the relationships between classes in a wholly inaccurate way that can hinder a reader from deciphering the true nature of the program, decreasing the credibility of the entire diagram.
As such, this is a "UML notation error" according to the course website (screenshot provided below), and the severity of this issue should at least be severity.Low
.
Issue
The UML class diagram (in the
FinancialList and FinancialEntry
section) shown below uses the wrong arrow to indicate class inheritance. The correct one from the course textbook is shown below that.Screenshots