nichyjt / pe

0 stars 0 forks source link

DG - Matrix Class diagram is too complex #17

Open nichyjt opened 1 year ago

nichyjt commented 1 year ago

Description

The matrix class diagram is very large and might be hard for developers to properly understand at one go.

It can be simplified and factored out to make things easier for the reader.

ExceptionPrinter may be omitted, and the Tensor connections could be its own class diagram.

image.png

nus-se-bot commented 1 year ago

Team's Response

Class diagram could be shown complicated. But I hope you understand that components indicated in Class diagram is all necessary to help understanding the whole logic of Matrix part for developers. Note that this is not for users.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I agree that it is completely fine for class diagrams to be more complex. But the diagrams should be understandable and readable.

It is plain to see that the attached class diagram could have been better formatted. Complexity is fine, but in this case the way the things were structured makes the diagram hard to read.

For example, there are many overlapping arrows in the diagram. This makes tracing through the diagram hard as a developer.