-
Notifications
You must be signed in to change notification settings - Fork 3
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
Updates to ui #188
Updates to ui #188
Conversation
Codecov Report
@@ Coverage Diff @@
## master #188 +/- ##
============================================
+ Coverage 52.99% 53.09% +0.10%
- Complexity 742 744 +2
============================================
Files 166 166
Lines 3106 3113 +7
Branches 344 345 +1
============================================
+ Hits 1646 1653 +7
Misses 1353 1353
Partials 107 107
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added comments for your review 😎
Thanks for the great effort here 👍
docs/DeveloperGuide.md
Outdated
@@ -801,15 +801,15 @@ testers are expected to do more *exploratory* testing. | |||
|
|||
1. Data files are saved in a `data` folder.<br> | |||
3 JSON files are created: | |||
* `addressbook.json` | |||
* `contactbook.json` | |||
* `meetingBook.json` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lower case 'b'
docs/UserGuide.md
Outdated
|
||
Format: `switch MODE` | ||
* `switch` `deliverable`, `meeting` and `contact` mode will display your list of deliverables, meetings and contacts in the left panel respectively, | ||
e.g. `switch contact` will display your list of contacts. | ||
* `MODE` can be dashboard (`db`), deliverable (`dv`), meeting (`m`) or contact (`c`). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reversed information: should be "MODE
can be db
(dashboard), dv
(deliverable), ..."
* `switch` `deliverable`, `meeting` and `contact` mode will display your list of deliverables, meetings and contacts in the left panel respectively, | ||
e.g. `switch contact` will display your list of contacts. | ||
* `MODE` can be dashboard (`db`), deliverable (`dv`), meeting (`m`) or contact (`c`). | ||
* `switch` `dv`, `m` or `c` mode will display your list of deliverables, meetings and contacts in the left panel respectively, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a mental note that we may need to explain the main components in our GUI (command box, feedback box, navbar, left panel, right panel) at the start of the UG with a screenshot
@@ -18,7 +18,8 @@ | |||
public static final String COMMAND_WORD = "view"; | |||
public static final String MESSAGE_VIEW_DELIVERABLE_SUCCESS = "Viewing deliverable: %1$s"; | |||
public static final String MESSAGE_USAGE = COMMAND_WORD | |||
+ ": Views the details of the deliverable identified by the index number used in the deliverable list.\n" | |||
+ ": Views the details of the deliverable identified by the index number used in " |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
May want to consider replacing "used" with "as shown"/"as seen"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Original phrasing of AB3, thinking it would better to just stick to that
@@ -33,7 +33,7 @@ | |||
+ PREFIX_LOCATION + "Room 1A"; | |||
|
|||
public static final String MESSAGE_SUCCESS = "New meeting added: %1$s"; | |||
public static final String MESSAGE_DUPLICATE_MEETING = "This meeting already exists in the meeting book"; | |||
public static final String MESSAGE_DUPLICATE_MEETING = "This meeting already exists in the meeting list"; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing fullstop?
|
||
public static final String MESSAGE_SUCCESS = "Mode switched to: %1$s"; | ||
public static final String MESSAGE_SAME_MODE = "Switched to same mode: %s!"; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider using You are already in this mode!
or Mode is presently displayed!
so it appears more like the user made a mistake.
+ "Parameters: MODE (must be " + ModeEnum.getModeOptions() | ||
+ ")\n" | ||
+ "Example: " + COMMAND_WORD + " " + ModeEnum.DELIVERABLE.getArgument(); | ||
|
||
|
||
public static final String MESSAGE_SUCCESS = "Mode switched to: %1$s"; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this mean users will get something like Mode switched to: dv
? Are we able to convert into Mode switch to: deliverable
(along with the other models) instead? 😨
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, its currently Mode switched to: Deliverable
@@ -34,7 +34,7 @@ | |||
+ PREFIX_DESCRIPTION + "End user"; | |||
|
|||
public static final String MESSAGE_SUCCESS = "New contact added: %1$s"; | |||
public static final String MESSAGE_DUPLICATE_PERSON = "This contact already exists in the address book"; | |||
public static final String MESSAGE_DUPLICATE_PERSON = "This contact already exists in the contact list"; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing exclamation mark? (Just ensure the message punctuations are consistent throughout the models)
@@ -16,9 +16,9 @@ | |||
*/ | |||
public class ViewCommand extends Command { | |||
public static final String COMMAND_WORD = "view"; | |||
public static final String MESSAGE_VIEW_CONTACT_SUCCESS = "Viewing contact: %1$s"; | |||
public static final String MESSAGE_VIEW_PERSON_SUCCESS = "Viewing contact: %1$s"; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Think we agreed previously that the messages should be from the perspective of the app. Here and else models, Viewing contact
should be Displayed contact: %1$s
.
Also, I think list command should be Listed all contacts!
if it is not already. Clear should be Cleared all contacts!
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To be fixed by #182
Updated in that PR
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Fix #144 (addressbook.log -> productiv.log)
Fix #139 (addressbook -> contactbook, commandresults 'book' -> 'list')
Fix #169
Fix #132 (warning message when switching to same mode)
Fix #164 (shorten Switch commands)