nus-se-script
commented
5 months ago Team's Response
*Duplicate of #785. Only valid portion of this bug is the function call arrows pointing to the middle of the activation bar. This is due to the arrows being correct but activation bar being wrong. The activation bars being cut off at the top instead of starting where the arrows point and hence this is the same problem as in #785.
-
Firstly the omission of return arrows is a visual choice to make the diagram less cluttered and does not result in loss of information, since the functions return call is void and serves no purpose in understanding the sequence of EditStudent.
-
The arrows pointing to the middle of the activation bar is due to the activation bar being wrongly activated. Nonetheless, this should not hinder the understanding of the sequence diagram. The purpose of this diagram is to show the flow of the function calls and we believe this flow is reflected clearly with all the function calls specific to the EditStudents component. In fact, the activation bar being there or not does not change the readers' understanding of the component.
Hence, we propose a severity of low instead as it does not affect the understanding of EditStudent component, let alone the whole DG as a product. This should only cause minor inconvenience only localised within this small part of the whole component.
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
Activation bars cut off
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.
As can be seen from the image, the activation bars are cut off at the top and bottom. In fact this is prevalent across several other DGs. This is a signficant bug as it will prevent readers from understanding when method is called.
Hence, I am assigning this a severity of medium.
[original: nus-cs2113-AY2324S2/pe-interim#716] [original labels: severity.Medium type.DocumentationBug]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
We believe this is definitely a valid error . However, this should not hinder the understanding of the sequence diagram, let alone the whole archive component or entire DG itself.
The purpose of this diagram is to show the flow of the function calls and we believe this flow is reflected clearly, despite the inaccurate activation bars. In the DG above the diagram, it is mentioned the diagram shows the sequence of function calls when archive command is activated by the user, hence it should be pretty obvious from the diagram starting from when the user inputs "archive".
Hence, we propose a severity of low instead as it does not seem significant and this bug is unlikely to affect comprehension of the ArchiveCommands component at all, let alone the usage of the whole DG.
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)
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.High`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]
multiple arrows are pointing to the middle of activation bars, and there is also no return arrow to the user. this diagram is almost illegible, hence the severity high bug