search

nzixuan / pe

0 stars 0 forks source link

Inconsistency with documentation of sequence diagrams #7

Open nzixuan opened 2 years ago

nzixuan commented 2 years ago

Inconsistency of documentation of sequence diagrams. In the first diagram parseCommand("task -e n/Report 4") was used in the second diagram parseCommand(student -v 3) was used without the " " to indicate a string.

Screenshot 2021-11-12 at 5.18.27 PM.png Screenshot 2021-11-12 at 5.18.37 PM.png

nus-pe-bot commented 2 years ago

Team's Response

Accepted.

Note: There is another duplicate issue regarding inconsistent input value in diagrams. They are considered duplicate issues because they were both regarding the lack of quotation marks around the input value.

The 'Original' Bug

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

Inconsistent input value in diagrams

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.

The presentation of input value in diagram is inconsistent. For arguments of execute, parseCommand, sometimes "" is present in brackets and sometimes not.

Screenshot 2021-11-12 at 5.21.31 PM.png

Screenshot 2021-11-12 at 5.21.40 PM.png

[original: nus-cs2103-AY2122S1/pe-interim#5164] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

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

Accepted.

Note: There is another duplicate issue regarding inconsistency with documentation of sequence diagrams. They are considered duplicate issues because they were both regarding the lack of quotation marks around the input value.

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.Low] Originally [severity.VeryLow]

Reason for disagreement: [replace this with your explanation]