search

UdhayaShan1 / pe

0 stars 0 forks source link

[DG] Possible typo in `find` sequence diagram #22

Open UdhayaShan1 opened 7 months ago

UdhayaShan1 commented 7 months ago

image.png

find alex should be find n/alex

nus-se-script commented 7 months ago

Team's Response

According to the course website we are allowed to omit unnecessary details in the UML diagrams. We believe that with or without the n/ it is clear that we want to find a person called alex.

In this screenshot the find n/alex was omitted in the diagram. image.png

image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: To reject this is to say my issue is downright wrong and that this diagram is expected and correct implementation.

In the same screenshot , it is also mentioned "does not ambiguities or loss of relevant information" which I believe applies to the method descriptions mostly. If we are adding the arguments already, we should at least go all the way and put in the extra effort to add a two letter n/ prefix to be clearer or not have any arguments in the method call at all.

This gives me the impression that find can parse without prefixes and for a developer guide where implementation details matters this could send the wrong message.