Skip to content
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

update documentation #219

Merged
merged 1 commit into from
Apr 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 2 additions & 58 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -437,61 +437,6 @@ ____________________________________________________________
____________________________________________________________
```

### Adding a location: `location`
Adds a location to an existing travel activity.

Format: `location INDEX LOCATION`

* The `INDEX` must be a valid activity index
*
Example of usage:

`location 3 Singapore`

Expected outcome:
```
____________________________________________________________
I have added a location to this task:
Go to Japan :14 Dec 2026 :2 hours (Japan)
____________________________________________________________
```

### Removing a location amount: `removelocation`
Removes a location to an existing travel activity.

Format: `removelocation INDEX`

* The `INDEX` must be a valid activity index.

Example of usage:

`removelocation 3`

Expected outcome:
```
____________________________________________________________
Location removed from the task:
Go to Japan :14 Dec 2026 :2 hours
____________________________________________________________
```

### Find activity from the list using activity location: `findlocation`

Find an activity based on their location. All activities with the given location will be listed out.

Format: `findlocation LOCATION`
* `LOCATION` has to match the activity location exactly to find the activity

Examples of usage: `findlocation Japan`

Expected outcome:
```
____________________________________________________________
Here are what you are looking for:
[ ] 1. General: Go to Japan :14 Dec 2026 :2 hours (Japan)
____________________________________________________________
```

Common currency codes:
* USA: USD
* EURO: EUR
Expand Down Expand Up @@ -530,10 +475,9 @@ same location of your other computer to transfer all the activities.
* Remove tag `untag INDEX`
* Find activity using activity tag `findtag TAG`
* Find activity using activity type `findtype TYPE`
* Lists out all tags `listtags`
* Add expense `expense INDEX EXPENSE`
* Remove expense `removeexpense INDEX`
* Total expense `totalexpense [/type TYPE]`
* Check currency exchange `change AMOUNT /from CODE /to CODE`
* Add location `location INDEX LOCATION`
* Remove location `removelocation INDEX`
* Find location `findlocation LOCATION`

19 changes: 6 additions & 13 deletions docs/team/chenkangg.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,25 +32,18 @@ providing an easy way to assist a user to view all the commands.
* Justification: This feature improves the product significantly because a user can add an expense to a travel activity
which can help to track their finances and conveniently remove the expense to rectify if required.

#### Added the ability to add and remove location
* What it does: allows the user to add a location to an existing travel activity and remove a location from an
existing travel activity if needed.
* Justification: This feature improves the product significantly because a user can add a location to a travel activity
which can help to better organise their travel activities to a specific location and conveniently remove the location
to rectify if required.
#### Added the ability to list tags

#### Added the ability to find a location
* What it does: allows the user to find a location from existing travel activities.
* Justification: This feature improves the product significantly because a user it allows the user to search for
travel activities based on location and sort the travel planner in an organised manner.
* What it does: allows the user to list out all the tags that have been added.
* Justification: This feature improves the product significantly because a user may have forgotten what tags they have
given to different travel activities. This feature allows users to view all tags quickly and easily.

#### Documentation:
* Contributions to the UG:
Added documentation for the features `help`,`tag`,`untag`,`expense`,`removeexpense`,`location`,
`removelocation`,`findlocation`.
Added documentation for the features `help`,`tag`,`untag`,`expense`,`removeexpense`,`findtags`.

* Contributions to the DG:
Added description of implementation of `tag` feature + sequence diagram.
Added documentation instructions for manual testing for the features `help`,`tag`,`untag`,`expense`,
`removeexpense`,`location`,`removelocation`,`findlocation`.
`removeexpense`,`findtags`.

3 changes: 0 additions & 3 deletions src/main/java/seedu/omnitravel/omnitravel/OmniTravel.java
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,6 @@ public static void main(String[] args) throws IOException {
case "expense":
case "removeexpense":
case "totalexpense":
case "location":
case "removelocation":
case "findlocation":
invokeCommand(command, line, list);
break;
case "help":
Expand Down
12 changes: 5 additions & 7 deletions src/main/java/seedu/omnitravel/ui/Ui.java
Original file line number Diff line number Diff line change
Expand Up @@ -98,13 +98,11 @@ public static void helpCommand(){
"14. update <update> <date> <duration> <tag>\n" +
"15. findtag <tag name>\n" +
"16. findtype <type>\n" +
"17. expense <activity number> <expense amount>\n" +
"18. removeexpense <activity number>\n" +
"19. totalexpense <type>\n" +
"20. change <amount> /from <current currency> /to <changed currency>\n" +
"21. location <activity number> <location>\n" +
"22. removelocation <activity number>\n" +
"23. findlocation <location>\n");
"17. listtags \n" +
"18. expense <activity number> <expense amount>\n" +
"19. removeexpense <activity number>\n" +
"20. totalexpense <type>\n" +
"21. change <amount> /from <current currency> /to <changed currency>\n");
printLine();
}
//@@author daryltay415
Expand Down
Loading