Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improper use of Diagram in DG #11

Open
hjl99 opened this issue Nov 13, 2020 · 1 comment
Open

Improper use of Diagram in DG #11

hjl99 opened this issue Nov 13, 2020 · 1 comment

Comments

@hjl99
Copy link
Owner

hjl99 commented Nov 13, 2020

Unnecessarily large diagram.

Screen Shot 2020-11-13 at 5.41.37 PM.png

and Complicated Diagram spanning across the page, causing problems of reading.

Screen Shot 2020-11-13 at 5.42.08 PM.png

@nus-se-bot
Copy link

Team's Response

First, in response to the "Unnecessarily large diagram" claim, we believe that having larger diagrams it gives the reader more clarity, as the diagrams are a key part of the DG.

The diagrams are also not that huge as it takes up less than half the width of the page.

Second, in response to "complicated Diagram spanning across the page", it is a problem due to exporting the document as PDF which does not affect the actual UG. We include details of the methods in each class so that other developers can get a sense of what methods are implemented in certain classes. In fact, the final diagram is already a stripped-down version of what we originally had in mind, and stripping down even more we cause the diagram to lose its meaning.

Thank you for your feedback.

Items for the Tester to Verify

❓ Issue response

Team chose [response.Rejected]

  • I disagree

Reason for disagreement: [replace this with your reason]


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants