Open yisiox opened 7 months ago
d refers to the AddClassCommand object, p refers to the parameters
Team chose [response.NotInScope
]
Reason for disagreement: Appreciate the clarification from the dev team, but I feel therein lies the issue as it needs to be clarified. p
is not mentioned in the text description and perhaps the reader may have guessed p
to be Person
instead of parameters as per other parts of the DG. Moreover, labelling the dotted arrows as d(p)
seems to suggest that it is calling a method instead of returning the AddClassCommand
object. The cross to signify object deletion is also missing. As such, I believe that this is a valid documentation bug that is in scope.
Description
The object deletion is missing from the command parser, which may be inferred to be present due to the other sequence diagrams in the DG. It is unclear what
d(p)
andp
refer to, as with many of the return arrows.Screenshot
Reason for Severity
The overall picture of how it is implemented is still clear, but the mistakes hinder the user slightly and reduces the credibility of the documentation.