Update DeveloperGuide with Switch Mode implementation #98
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #98 +/- ##
============================================
- Coverage 50.51% 50.30% -0.21%
- Complexity 609 610 +1
============================================
Files 141 141
Lines 2647 2664 +17
Branches 303 307 +4
============================================
+ Hits 1337 1340 +3
- Misses 1213 1224 +11
- Partials 97 100 +3
Continue to review full report at Codecov.
|
claraadora
approved these changes
Oct 22, 2020
docs/DeveloperGuide.md
Outdated
|
|
||
| #### Implementation | ||
|
|
||
| Productiv can be in different modes, such as dashboard, deliverable, meeting and contact mode. |
There was a problem hiding this comment.
Very minor, but maybe can use 'specifically' or 'different modes: dashboard, deliverable,...'
docs/DeveloperGuide.md
Outdated
|  | ||
| Figure <?> Switch Command Sequence Diagram (In Progress) | ||
|
|
||
| The user input is passed to LogicModeManager. |
docs/DeveloperGuide.md
Outdated
| * Cons: May violate Single Responsibility Principle. | ||
|
|
||
| * **Alternative 2:** Store mode in a `LogicModeManager` | ||
| * Pros: Seems to follow the Single Responsibility Principle better. |
There was a problem hiding this comment.
Maybe can be assertive and say "Aligns with / Follows the Single Responsibility Principle better"
|
|
||
| * **Alternative 2:** Store mode in a `LogicModeManager` | ||
| * Pros: Seems to follow the Single Responsibility Principle better. | ||
| * Cons: `LogicModeManager` would need to have references to the other logic managers. |
| SwitchCommandParser --> ModeParser | ||
| deactivate SwitchCommandParser | ||
|
|
||
| ModeParser --> LogicModeManager : s |
There was a problem hiding this comment.
Maybe can use a more descriptive name than 's'?
| LogicModeManager --> MainWindow : result | ||
| deactivate LogicModeManager | ||
|
|
||
| MainWindow -> MainWindow: switchMode(mode) |
There was a problem hiding this comment.
Not sure, but is mode the same as result?
chrystalquek
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.