yucongkoo / pe

0 stars 0 forks source link

Sequence diagram under RemovePolicy is too small #16

Open yucongkoo opened 11 months ago

yucongkoo commented 11 months ago

Screenshot 2023-11-17 at 5.20.03 PM.png

The sequence diagram is too small and hinders users from reading

soc-pe-bot commented 11 months ago

Team's Response

The diagram is too small but it is possible to zoom in as it is on a computer, however the diagram will be cut off if it is larger.

The 'Original' Bug

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

Some diagrams are 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.


Screenshot 2023-11-17 at 17.27.04.png

Using ref frames may be appreciated.


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

Their Response to the 'Original' Bug

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

The diagram is too small but it is possible to zoom in as it is on a computer, however the diagram will be cut off if it is larger.

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: Quoting from the course website PE instructions: Screenshot 2023-11-21 at 12.55.10 PM.png

These diagrams are separate diagrams, and hence can be fixed individually. They are somewhat similar to the multiple typos issue. Hence, I don't think this should be marked as a duplicate bug to the original bug.


## :question: Issue response Team chose [`response.Rejected`] - [x] I disagree **Reason for disagreement:** For the dev teams response: >The diagram is too small but it is possible to zoom in as it is on a computer, however the diagram will be cut off if it is larger. But I the fact that the diagram itself being too small is already somewhat hindering the readers, since they would need to zoom in and out when reading the documentation, even worse when reading a printed pdf version where zooming in and out is not an option. Also, quoting the following from the course website, these can indeed be considered cosmetic issues. ![Screenshot 2023-11-21 at 12.58.02 PM.png](https://raw.githubusercontent.com/yucongkoo/pe/main/files/af5374a2-1fe8-4b4d-bcea-4c183b9865ba.png)