nus-cs2103-AY2021S2 / pe-dev-response

0 stars 0 forks source link

DG: Spacing between class name and object name #960

Open nus-pe-bot opened 3 years ago

nus-pe-bot commented 3 years ago

Should not have spacing between the name of the object and the name of the class. i.e result :CommandResult is wrong result:CommandResult is correct. See CS2103 textbook, Sequence Diagrams, Calls to Static Method, for reference on notation. See the first picture, which is incorrect, vs the second picture, which is correct, notation-wise.

1st: Screenshot 2021-04-16 at 3.10.11 PM.png 2nd: Screenshot 2021-04-16 at 3.12.48 PM.png


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

swayongshen commented 3 years ago

Team's Response

Reason for downgrade: Even if what is stated is true, it does not affect a user's reading and understanding of the DG.

Reason for reject: It was not explicitly stated that there should be no space between the object name and the class name.

In object diagrams section: image.png

In sequence diagram section: image.png

Duplicate status (if any):

--