search

nicholastng010601 / pe

0 stars 0 forks source link

Incomplete sequence diagram #8

Open nicholastng010601 opened 10 months ago

nicholastng010601 commented 10 months ago

In the developer's guide, much of the filter feature's sequence diagram was truncated to the point where the graph was inadequate to help future developers understand how the feature was implemented. More steps could be added for future DG diagrams such as how the predicate is gotten or how the input is parsed.

Screenshot 2023-11-17 at 4.57.38 PM.png

nus-se-script commented 9 months ago

Team's Response

image.png

To be more specific,

Regarding "how the predicate is gotten": The role of ContainsTagPredicate predicate is clearly explained just below the diagram. Showing all details of its instantiation is unnecessary to understand the high-level implementation of filter.

Regarding "how the input is parsed": this is completely separate from the execution depicted in the given diagram, and completely similar to the parsing of all other commands. It is omitted to avoid unnecessary repetition, and to avoid the diagram becoming unnecessarily complicated and unreadable (small font).

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: With all the important details abstracted out, the graph provides little information to the developer. More could have been done, such as potentially breaking the diagram into smaller fragments to show more information regarding their implementation.