Update UGDG #149
Update UGDG #149
Conversation
|
For issue: #141 |
docs/DeveloperGuide.adoc
Outdated
|
|
||
| *Step 1.* The user launches the application for the first time. The user's email address is string `"default"` by default. | ||
|
|
||
| *Step 2.* The user executes `check`. The command executes `ModelManager#getMyEmail()`, which calls `UserPrefs#getDefaultEmail()` and returns user's email stored in `UserPref`. The app checks if user's email equals to `"default"`. In this case, they are equal, so it throws a `CommandException`. |
There was a problem hiding this comment.
Could use a sequence diagram.
There was a problem hiding this comment.
Do you mean a sequence diagram to show the whole procedure or just this step?
There was a problem hiding this comment.
Just this step. Though feel free to add more diagrams in other places if you think it helps.
docs/DeveloperGuide.adoc
Outdated
|
|
||
| . Send a reminder email successfully. | ||
|
|
||
| `add` a loan with a valid customer's email (but you own it of course). Execute `check` command. Then use the `setemail` command to set the sender's email. After that, execute `remind x/correctpassword n/Name b/BikeId`. + |
There was a problem hiding this comment.
Could be converted to point form to make things clearer.
There was a problem hiding this comment.
I've corrected some language styling. Please verify that I did not misinterpret anything.
Overall comments:
The procedures have quite a few if-else cases (such as the example usage scenario Step 3). I would suggest indenting the individual cases to make things clearer.
When specifying a loan to send a reminder to, you can use the LoanID instead of specifying a Name and Bike, as the latter is more complicated and may not uniquely identify a loan.
May I also suggest renaming the check command to checkemail, so that what it does is clearer?
|
"CommandException" in the diagram is spelled incorrectly. |
No description provided.