search

yeozongyao / pe

0 stars 0 forks source link

Missing colon for instance #13

Open yeozongyao opened 5 months ago

yeozongyao commented 5 months ago

image.png

For this sequence diagram for identifying a student, the instance at the top is missing the colon, which would cause developers to not understand that it is an instance. This will cause developers to misunderstand the programme. Hence, I am assigning this a severity of medium.

nus-pe-bot commented 5 months ago

Team's Response

It is in fact not an instance, but rather calling a class method. Regardless, it does not greatly hinder the user's ability to understand the diagram.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

missing ":" in sequence diagram

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.

image.png

none of the labels have a ":" to indicate they are objects. If class-level methods are being called, the label <<class>> should be used, which is not being used here.

almost every other sequence diagram has this issue, hence the severity level of medium was given

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

Their Response to the 'Original' Bug

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

Those are in fact not objects, but rather classes. Regardless, the ability of the reader to understand the sequence is not hindered.

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: [replace this with your explanation]

## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** While I agree it is a duplicate, I disagree that this is a bug of very low severity. I belive the user's ability to understand the diagram is indeed hindered by the omission of `<>` labels or `:` labels. Users will be confused as to whether the commands being called are class-level methods or not. Since the team clarified that class level methods are being called, the `<>` label should be used to prevent confusion to readers. The non-trivial impact on the user's ability to interpret the diagram justifies the severity level of medium for this bug, which is definitely not a cosmetic flaw.