Skip to content

Commit

Permalink
[103] Document that index must be a positive integer (#129)
Browse files Browse the repository at this point in the history
  • Loading branch information
damithc authored Sep 29, 2016
1 parent 6fc3b16 commit e85c3d7
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 4 deletions.
6 changes: 4 additions & 2 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,8 @@ Deletes the specified person from the address book. Irreversible.<br>
Format: `delete INDEX`

> Deletes the person at the specified `INDEX`.
The index refers to the index number shown in the most recent listing.
The index refers to the index number shown in the most recent listing.<br>
The index **must be a positive integer** 1, 2, 3, ...

Examples:
* `list`<br>
Expand All @@ -84,7 +85,8 @@ Selects the person identified by the index number used in the last person listin
Format: `select INDEX`

> Selects the person and loads the Google search page the person at the specified `INDEX`.
The index refers to the index number shown in the most recent listing.
The index refers to the index number shown in the most recent listing.<br>
The index **must be a positive integer** 1, 2, 3, ...

Examples:
* `list`<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ public class DeleteCommand extends Command {

public static final String MESSAGE_USAGE = COMMAND_WORD
+ ": Deletes the person identified by the index number used in the last person listing.\n"
+ "Parameters: INDEX\n"
+ "Parameters: INDEX (must be a positive integer)\n"
+ "Example: " + COMMAND_WORD + " 1";

public static final String MESSAGE_DELETE_PERSON_SUCCESS = "Deleted Person: %1$s";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ public class SelectCommand extends Command {

public static final String MESSAGE_USAGE = COMMAND_WORD
+ ": Selects the person identified by the index number used in the last person listing.\n"
+ "Parameters: INDEX\n"
+ "Parameters: INDEX (must be a positive integer)\n"
+ "Example: " + COMMAND_WORD + " 1";

public static final String MESSAGE_SELECT_PERSON_SUCCESS = "Selected Person: %1$s";
Expand Down

0 comments on commit e85c3d7

Please sign in to comment.