search

Fureimi / pe

0 stars 0 forks source link

User is labelled as a class in DG + Activation bar never ends #13

Open Fureimi opened 7 months ago

Fureimi commented 7 months ago

image.png Under: Listing all Books, alternatives considered

Under this sequence diagram, user is labelled as a class even though there is no User class.

In addition, activation bar for ParserMain ends after it returns.

nus-se-script commented 7 months ago

Team's Response

Thanks for bringing this up!

You might have been mistaken about the activation bar and the return of the confirmation message! The confirmation message is the return from the Ui class.

Nevertheless, we agree that the user being labelled as a class is a mistake!

We have marked this as a duplicate of #2339.

Hope this clarifies!

The 'Original' Bug

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

Incorrect sequence diagram notation

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.

Throughout the DG, there are multiple sequence diagrams where the leftmost entity is seen to be :User where the existence of a User class is nowhere to be found. If the intention was to have the :User entity represent an actual user, then an actual user entity (refer to the last attached image) would have been more clear to future developers reading the documentation.

Examples are attached below: image.png

image.png

image.png

CS2113 Website Example:

image.png

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

Their Response to the 'Original' Bug

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

Thank you for pointing this out. However as this is merely a cosmetic issue in the DG, we feel that the severity should be very low.

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:** If a programmer were to read your DG and see this SQ, they would intepret :User as a class, not an actual user. This might lead to issues with understanding of how your command works and they might look for a User class when handling your code, which does not exist