nus-pe-bot
commented
3 years ago Team's Response
Similar issues where diagrams are cut-off in the DG.
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
DG - Diagrams cut off
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.
Most diagrams are cut off to fit into document, and are affected by page breaks.
[original: nus-cs2113-AY2021S2/pe-interim#992] [original labels: severity.High type.DocumentationBug]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
Although it's cut-off due to the pdf formatting and the details that need to be zoomed in/visible. The website shows this diagram clear enough. This bug does not affect tester's understanding of the graph.
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)
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
:question: Issue severity
Team chose [severity.Low]
Originally [severity.High]
- [x] I disagree
Reason for disagreement: The words cut off and small texts will cause inconvenience to future developers reading the DG. (According to the module website, visuals that are not well formatted when saving the github.io site to pdf are considered as bugs)
Many of the diagrams are not properly shown in the DG. (Refer to screenshots) Almost all the diagrams are either cut-off due to being too wide, or getting separated into separate pages.