yisiox / pe

0 stars 0 forks source link

Errors in Add Class sequence diagram in DG #13

Open yisiox opened 7 months ago

yisiox commented 7 months ago

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) and p refer to, as with many of the return arrows.

Screenshot

image.png

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.

soc-se-bot commented 7 months ago

Team's Response

d refers to the AddClassCommand object, p refers to the parameters

Items for the Tester to Verify

:question: Issue response

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.


## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** Following the suggestions by the course website, I believe that the original assessment and justification of the severity is accurate as it is not a cosmetic bug and the reader may second guess. ![image.png](https://raw.githubusercontent.com/yisiox/pe/main/files/182d87e6-cf59-40d0-9b20-9f56ba9f48f0.png) ![image.png](https://raw.githubusercontent.com/yisiox/pe/main/files/c1ce27d3-d217-4265-8efd-ad94b446ce1c.png)