search

nonrnp / pe

0 stars 0 forks source link

Confusing reference label in sequence disagram #13

Open nonrnp opened 2 years ago

nonrnp commented 2 years ago

image.png

image.png

The reference label from MainParser sequence diagram is different from the one shown below, which makes it confusing whether if it is the continuation from the first diagram.

nus-pe-bot commented 2 years ago

Team's Response

The reference is meant to be used by various commands. However, for the sake of not repeating this MainParser diagram, we decided to use a more general reference description so that other commands are able to leverage the use of this diagram. This can be seen in Detailed Edit Contact Parsing under the Editing a contact section.

image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: In such case, then the reference fields should be written as Detailed Parsing in all diagram instead, whereas the specific parser type can be put as a description outside the diagram. In this case, such method is not used which make the diagrams confusing to the reader as the result. Considering this, I disagree with the rejected response from the developers.