Kobot7 / pe

0 stars 0 forks source link

ShopMap Sequence Diagram: Action Bar disappears abruptly #11

Open Kobot7 opened 2 months ago

Kobot7 commented 2 months ago

Problem

Under section Map Component: ShopMap Class,

It would be better to be consistent as :TextBox has an action bar that disappears halfway which may be mislead user to think that the execution has ended.

May be better to standardise and ensure that all action bars are shown.

Screenshot

image.png

nus-pe-script commented 2 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]

No activation bar when method calls

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.


Activation bar should be activated once a method is called from that class, and deactivated once returned.

image.png


[original: nus-cs2113-AY2324S2/pe-interim#2049] [original labels: severity.Medium type.DocumentationBug]

Their Response to the 'Original' Bug

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

Screenshot 2024-04-20 at 6.51.43 PM.png Optional elements may be omitted e.g. activation bars. The omission of activation bars here do not result in ambiguities or loss of relevant information in this case, hence is allowed.

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: The "Original" bug focuses on the lack of action bars when a method is called. However, this bug focuses on how the action bar is shown but deactivates halfway through execution despite the arrows indicating that it should still be active.


## :question: Issue response Team chose [`response.Rejected`] - [x] I disagree **Reason for disagreement:** Hi team, yes I understand that activation bars may be omitted. However, in this case the team has chosen **to display the activation bar** as seen in the diagram below. ![image.png](https://raw.githubusercontent.com/Kobot7/pe/main/files/3242618a-2f1b-4bdb-a7da-16d8b22fe278.png) Since the team has chosen to show the activation bar for that section, it doesn't make sense to abruptly end it despite it clearly being still in execution (refer to red circle in diagram above), as inferred from the method call to itself. This confuses the users as the deactivation of the bars would indicate that the function has returned. The fact that activation bars are optional is not a valid reason to randomly deactivate the activation bar as and when the team wishes. In addition, I would like to highlight the following paragraph from the CS2113 website. ![image.png](https://raw.githubusercontent.com/Kobot7/pe/main/files/5659b8f9-73f4-4c72-b4cd-4bf22ec7c9b2.png) I hope this clears things up in regards to the bug. Thanks!