pzl111 / pe

0 stars 0 forks source link

Unrecognised notation of arrow calling function leftwards #36

Open pzl111 opened 11 months ago

pzl111 commented 11 months ago

Textbook has never shown that it is allowed for commands to be called pointing leftwards, hence readers from CS2103T would not recognise this as valid.

image.png

nus-se-bot commented 11 months ago

Team's Response

Thanks for your feedback!

Here is an example from the CS2103/T textbook where a command is called pointing leftwards:

image.png

In addition, there has been no limitation stated in the textbook where a leftward-pointing operation invocation arrow is not allowed for sequence diagrams. Hence, we chose to reject your bug.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: The CS2103/T textbook shows the arrow where a command is called pointing leftwards, because given that getText() was called, there is no way for the getAuthor() method to point rightwards, also it is during the same execution of the write() method, hence it makes sense to do so.

However for the UG diagram, there is simply no reason for the use of the leftwards arrow, it could have been placed on the right, hence I don't see the rationale to do so. It seems rather of a documentation issue that they didn't check for this inconsistency which could be avoided, where all other diagrams in the UG does not have this quirk.

Furthermore, whilst there is no limitation on a leftward-pointing operation invocation arrow, it is simply not taught to CS2103T students and would naturally and understandably expect some confusion, because not saying anything about it doesn't mean it is allowed.

As it is a cosmetic issue and using unfamiliar conventions (which could be avoided during checking), I decide to put it as very low severity.