malcolmang / pe

0 stars 0 forks source link

Overly verbose parameter definition in sequence diagram #11

Open malcolmang opened 1 year ago

malcolmang commented 1 year ago

image.png

In the above picture, when functions are called, the parameters have both the name and type. This is unncessary and makes it much harder to read. As seen in the example from the CS2113 website below, explaining the type is not needed when writing out a method call in a sequence diagram.

image.png

nus-pe-bot commented 1 year ago

Team's Response

Hi there,

Due to the nature of our program consisting of many different types (e.g Expense, Income just to name a few), we think that it is important to list out the type of each parameter to make it clear to the developers. Furthermore, we believe that having these specific types listed does not compromise on readability.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your explanation]