search

Rishit02 / pe

0 stars 0 forks source link

Stuff missing in find class diagram #36

Open Rishit02 opened 7 months ago

Rishit02 commented 7 months ago

image.png

COMMAND_WORD is missing in find class diagram toString is also missing

nus-se-bot commented 7 months ago

Team's Response

Class diagram can omit certain details and it was our team's collective deliberate decision to omit those in order to simplify the diagram

image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: I believe that the COMMAND_WORD, is an important part of the class.

To draw a comparison: it's like a Person has a name and a Command has a COMMAND_WORD. Through this word the Find Command is accessed, and without the knowledge that this exists the developer may be unclear how exactly the input from the user is parsed.

Thus, I believe that the COMMAND_WORD is an imperative part of the class diagram that should not have been left out (or it should have been indicated why it was left out).

Moreover, it is a little confusing why the toString method was left out but the equal method was not left out, since both are overridden methods that seem equally important. This haphazard omission is why I also included the omission of the toString method in my initial issue.