search

petermonky / pe

0 stars 0 forks source link

Sequence diagram in Developer Guide is not relevant #18

Open petermonky opened 2 years ago

petermonky commented 2 years ago

image.png

The sequence diagram in the Architecture section of the Developer Guide is not relevant to onlyFAs; the diagram is directly from AB3's Developer Guide and serves no purpose here.

soc-pe-bot commented 2 years ago

Team's Response

We believe that this sequence diagram is still relevant as we did not make any (functional) changes to this portion of the AB3 source code. We would appreciate more clarification as to why you believe that it is not relevant to our product.

Items for the Tester to Verify

:question: Issue response

Team chose [response.IssueUnclear]

Reason for disagreement: The purpose of the sequence diagram is to model the interactions between entities in onlyFAs, not AB3. onlyFAs' command word for deleting a client is not delete but deleteClient. By the same token, the method called on a Model is not Model::deletePerson but Model::deleteClient. Developers who plan on extending onlyFAs may find it difficult to do so when they find that the sequence diagram above does not align with the actual code base, effectively rendering this issue a non-trivial one. However, reviewing it now, a severity of severity.Low may be more appropriate as the command sequence itself looks correct.