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

Update DG overall styling to CS2101 standards #93

Closed
eugene3231 opened this issue Oct 17, 2020 · 1 comment
Closed

Update DG overall styling to CS2101 standards #93

eugene3231 opened this issue Oct 17, 2020 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@eugene3231
Copy link

eugene3231 commented Oct 17, 2020

Update version number in MainApp.java

Introduction missing --> Revise it ✅
legend?
number the subheadings ✅
numbering (or bulletpoints all the way to be consistent) ✅
label diagrams to reference it ✅
write and document as you code

App vs app ✅

rest of the app contains four components -> use colon ✅
more consistent in sentence structure and type of word that it starts with. ✅

UNDOREDO -> active voice being used. ✅
no need to give explanation for the undoredo diagrams, quite self explanatory ✅

undo/redo design consideration: why did we choose alternative 2. Give a quick and simple reason. ✅
sentence structure for the pros/cons etc. Full sentence, or using of modals(will/may). Make it consistent ✅

Logic Component --> numbering ✅

@eugene3231 eugene3231 added the documentation Improvements or additions to documentation label Oct 17, 2020
@eugene3231
Copy link
Author

Closing this issue as the DG problems listed above have been fixed by #101 and #111

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

No branches or pull requests

5 participants