search

angkl0 / pe

0 stars 0 forks source link

Unnecessary parameters in execute() and parse() methods in sequence diagram under adding tasks section. #15

Open angkl0 opened 1 year ago

angkl0 commented 1 year ago

Adding all the parameters hinders the reader by slowing down the reader with unnecessary details and small font of the words.

nus-pe-script commented 1 year ago

Team's Response

Details provided is to give an example of the command being called Not a bug as user can zoom in on diagram

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Small Fonts in UML Diagrams

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.

Barely readable texts on some uml diagrams. Likely barely legible when printed, where readers cannot zoom in.

Screenshot 2022-11-11 at 17.24.23.png

[original: nus-cs2103-AY2223S1/pe-interim#5738] [original labels: severity.Medium type.DocumentationBug]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

As can be seen from this bug report, the diagram is still readable. The reader can choose to zoom in on the diagram as well.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: As per the module website: While the reader can zoom to see smaller details, this can still be considered a cosmetic issue (i.e., severity.VeryLow).