search

Shauryan123 / pe

0 stars 0 forks source link

Activation Bar is not visible, and is cropped out in the diagram #21

Open Shauryan123 opened 3 months ago

Shauryan123 commented 3 months ago

Screenshot 2024-04-19 at 5.18.05 PM.png

The activation bar for mainwindow:CourseMateListSelectHandler is not fully visible.

nus-se-bot commented 2 months ago

Team's Response

This is a valid concern. However, considering only the end of the activation bar gets cropped, and no other information is lost (the return arrows are optional accordinging to the course website), we will be downgrading the severity to "Low" as it only causes minor hindrance to some readers.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: I disagree with the development team's decision to downgrade the severity of the issue to "Low." The visibility of an activation bar in a sequence diagram is critical as it accurately represents the duration of control within a particular component of the system, in this case, the mainwindow:CourseMateListSelectHandler. The cropping out of the activation bar's end can lead to ambiguity regarding the scope and duration of the component's activity, which is fundamental for understanding the system's behavior and sequence of operations.

While it might seem like a minor graphical issue, the impact on comprehension can be significant, especially for new developers or maintainers of the project who rely on these diagrams for an accurate understanding of the system architecture and interactions. The absence of clear visual cues about the lifecycle of a process within a sequence diagram defeats the purpose of using such a precise modeling tool, leading to potential misunderstandings or incorrect implementations during future development efforts.

Therefore, this issue should be considered of "Medium" severity. It directly impacts the usability of the documentation in conveying essential architectural details and can affect the effective maintenance and extension of the application by other developers. The accurate representation of system interactions in UML diagrams is not merely a cosmetic concern but a fundamental aspect of effective software documentation and understanding.