migfoo02 / pe

0 stars 0 forks source link

Small font for sequence diagram #17

Open migfoo02 opened 12 months ago

migfoo02 commented 12 months ago

Screenshot 2023-11-17 at 5.36.59 PM.png

Font is a bit too small for this diagram. Hard to read the text in the box.

nus-pe-script commented 11 months ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Picture for implementation of event add volunteer feature is too small

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.


The sequence diagram for event add volunteer feature implementation is very small due to the high number of components involved.

The text for method calls becomes almost unreadable without zooming in.

image.png


[original: nus-cs2103-AY2324S1/pe-interim#5348] [original labels: type.DocumentationBug severity.VeryLow]

Their Response to the 'Original' Bug

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

Our group's view is that most of us are able to read the words and commands from the DG without having to zoom in. Unfortunately, there is no way for the diagram to be made any bigger since it takes up the whole width of the DG page.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]


## :question: Issue response Team chose [`response.Rejected`] - [x] I disagree **Reason for disagreement:** While I agree that the words and commands are still readable with some effort, most users would need to zoom in to comfortably view all the components in the sequence diagram. It is actually possible to address this by splitting the sequence diagram into two parts: the parser section and the actual execution. Attached below is an example of what my team did to address this: ![Screenshot 2023-11-21 at 6.11.27 PM.png](https://raw.githubusercontent.com/migfoo02/pe/main/files/06d12bca-7d6e-4a02-911b-dd933458c77d.png)