Update DG with details done by Wu Qirui #290
Merged
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
siangernlow
reviewed
Nov 7, 2020
docs/DeveloperGuide.md
Outdated
| * If user specifies number of high risk locations in the command, then number of high risk locations would be the user | ||
| specified value. | ||
| * If user does not specifies number of high risk locations, then number of high risk location of infection is | ||
| determined using the following rule: | ||
| * If number of infected location is larger than 60% of number of total number of location, then the number of high risk |
There was a problem hiding this comment.
This part is quite technical, so you could perhaps consider adding some diagrams? A simple diagram would suffice. Alternatively, you may provide an example with concrete numbers to bring the idea across more clearly.
docs/DeveloperGuide.md
Outdated
|
|
||
| **Rationale** | ||
| Instead of always using the pre-defined rule within VirusTracker, this implementation allows users to customize the | ||
| number of high risk locations displayed in VirusTracker. If the pre-defined rule is in used, users might not be able to |
There was a problem hiding this comment.
Small grammatical error. ... is in used -> is in use.
docs/DeveloperGuide.md
Outdated
| view more infected locations beyond the displayed high risk locations that are selected automatically by VirusTracker. | ||
|
|
||
| ##### Aspect: Determining number of high risk locations for infection when user does not specify the number | ||
| In the case when user does not specify the number of high risk locations in the command, the system itself will |
There was a problem hiding this comment.
Small grammatical error. In the case when the user...
| @@ -4,7 +4,7 @@ start | |||
| 'Since the beta syntax does not support placing the condition outside the | |||
| 'diamond we place it as the true branch instead. | |||
|
|
|||
| repeat :User executes deleteVisit command; | |||
| repeat :User executes deleteLocation command; | |||
There was a problem hiding this comment.
Is this supposed to be deleteVisit instead? It is in the DeleteVisitActivityDiagram.puml file.
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.
Added parts about
editLocationanddeleteLocation.