soc-se-bot
commented
2 months ago Team's Response
Duplicate of #781 as 781 is about all activation bars in the DG not being properly closed .
We believe this is definitely a valid error in documentation visuals. However, 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, despite the inaccurate activation bars.
In fact, the activation bars can be omitted since it is not important for understanding how the component works.
Hence, we propose a severity of low instead as it should not affect comprehension of the EditStudent component and will cause minor inconveniences only.
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.Medium`] - [x] I disagree **Reason for disagreement:** i disagree with the downgrading to a low severity, as i believe this issue causes significant impact to the reader. the incorrect activation bars misrepresent the duration of the method calls in the sequence diagram, which may confuse the reader about the interactions between the different objects in the sequence diagram. for example, under `EditCommand`, the user could have interpreted the `editStudent` method as ending before the `NAME` input was given by the user, or they could also interpret it as the `editStudent` method taking in the `NAME` input by the user. there are many other similar possibilities of such misinterpretation in the diagram. the team also claims that the activation bars are unimportant in this diagram, but i conversely feel that they are imperative in this diagram for the user to truly grasp the sequence flow of the feature. this is due to the fact that the feature utilizes multi-step commands, which will definitely confuse the user if activation bars were omitted/done incorrectly, as described in the example above. as such, i believe this justifies the bug to maintain a severity level of medium.
the activation bars in this diagram are not closed off properly