yeozongyao / pe

0 stars 0 forks source link

User human character in sequence diagram for calling editStudent and editing gender #10

Open yeozongyao opened 5 months ago

yeozongyao commented 5 months ago

image.png

As seen above, for the user input, there is a human character there which is not standard notation for this course in sequence diagrams and should be removed.

soc-pe-bot commented 5 months ago

Team's Response

Duplicate of #785 as it is about having the "user" actor in the diagram

The 'Original' Bug

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

Inconsistency in sequence diagrams in the developer guide

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

image.png

Some sequence diagrams have the user element, some sequence diagrams do not have the user element. This inconsistency will cause readers to be confused over the calling of commands and classes. However, this can be resolved by knowledge from the reader, I am assigning this a severity of low.


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

Their Response to the 'Original' Bug

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

Accepted, but it is a pure cosmetic issue and does not hinder the comprehension of the diagram at all.

image.png

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: I disagree that this is a duplicate.

The accepted bug that I reported is that of non-standard notation of the actor.

The original duplicated bug that I also reported is that of inconsistent cosmetic layout throughout the developer diagram.

Hope this clarifies!


## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]