xenthm
commented
5 days ago Team's Response
The team does not agree that the provided object namings are unnecessary to the sequence diagrams as pointed out by the tester. Using the cited AddMangaCommand Sequence Diagram as an example, there is a need to differentiate between the incomingAuthor and existingAuthor Author instances as the former is newly created for comparison purposes while the latter is the actual existing Author instance that was already present in the program.
Following the tester's suggestion of omission of object names would in fact be counter productive and impede clarity as the reader would not be able to differentiate as well which Author instance is new and which was already in existence within the program. The object namings are also consistent with how the objects are referenced and manipulated in the source code, which serves to provide additonal guidance to potential developers on how the various objects actually interact in the source code during runtime.
Thus, as the object namings do serve to improve the reader's understanding rather than impede it, the team has decided to reject the bug.
Duplicate status (if any):
--
In the above two sequence diagrams, the classes are given object namings. However, this is unnecessary for the purpose of the sequence diagrams and could perhaps be omitted to improve clarity.
[original: nus-cs2113-AY2425S1/pe-interim#611] [original labels: type.DocumentationBug severity.VeryLow]