nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

User is labelled as a class, ParserMain class missing activation bar, and ParserFind activation bar too long #382

Open nus-se-script opened 6 months ago

nus-se-script commented 6 months ago

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.


image.png

Under: BookFind Class Component, alternatives considered

User is labelled as a class instead of an actor. ParserMain is missing activation bar, unsure if it returns anything. ParserFind activation bar is longer than the last dotted arrow


[original: nus-cs2113-AY2324S2/pe-interim#436] [original labels: severity.Medium type.DocumentationBug]

liuzehui03 commented 5 months ago

Team's Response

Helloo, thank you for your feedback!

  1. User: we will take note of this typo error thank you for raising it! this is a duplicate of issue #2339 This kind of error does not impact the overall credibility of the diagram or impede the reader’s ability to follow the sequence of events.
  2. Missing Activation Bar: The absence of an activation bar on the 'ParserMain' class might be an oversight; however, the sequence diagram is still understandable without it, this omission is not likely to cause confusion or misinterpretation of the process flow. It does not detract from the primary purpose of the diagram, which is to convey the order and interaction of components in the system.
  3. Activation Bar Length: The length of the activation bar for 'ParserFind' extending beyond the last dotted arrow is a minor graphical discrepancy. It does not mislead the reader about the functionality or sequence of operations. The core information about the process remains clear. Based on the explanation given for handling bugs that do not hinder the reader, such as minor formatting issues and cosmetic issues, these are classified as 'VeryLow' severity unless they significantly impact the reader’s ability to understand the diagram. thank youu :)

Duplicate status (if any):

--