Skip to content
This repository has been archived by the owner on Apr 28, 2021. It is now read-only.

Commit

Permalink
Merge pull request #332 from seanlowjk/sean-ppp-changes
Browse files Browse the repository at this point in the history
Make Changes to Sean's PPP
  • Loading branch information
tanamaroby authored Nov 11, 2019
2 parents bfed0f4 + cac9a2b commit 13e1ba8
Showing 1 changed file with 16 additions and 35 deletions.
51 changes: 16 additions & 35 deletions docs/team/seanlowjk.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,11 @@ The sorting feature allows users to sort the list of food based on some criterio
specific fields given from the command line interface, or the preset comparator which the user has created.

For example, if the user wishes to see the list of food items in order of ascending price, the list will be then sorted.
As a result, the cheapest food item will be on the top of the food list, followed by the second cheapest food item. And
finally, the most expensive food item will be on the bottom of the food list.
As a result, the cheapest food item will be on the top of the food list and
the most expensive food item will be on the bottom of the food list.

Not only that, the user can turn autosorting on or off. As a result, when the user adds a new food item, the food list
will be autosorted immediately.
will be sorted immediately.

==== Justification

Expand Down Expand Up @@ -72,44 +72,14 @@ criterion at the top of the food list.

Finally, they should be able to view the fields of the custom comparator using `viewsort`.

=== Minor Enhancement: Alias Feature

I have added a alias feature to $aveNUS which allows users to create shortcuts for commonly used commands.

==== What it does

The alias feature allows users to create shortcuts for commonly used commands. For example, if the user wishes to
view the custom comparator made, but does not want to type in `viewsort` all the time, he can add an alias to it. He
can do use by typing `alias viewsort v` where `v` is now the shortcut for `viewsort`.

When he does not require the alias for `viewsort`, he can clear it anytime using `alias viewsort`.

==== Justification

NUS Students occasionally forget how to execute certain commands which may seem too long such as `viewsort` and
`customsort`. As a result, it would be good for the user to be able to add shortcuts to save time and typing.

==== Highlights.

I only had to add the `alias` command to implement this new feature. However, I had to make sure that users will not
accidentally keep in other conflicting shortcuts. For exampke, `alias viewsort sort`. is an invalid command as `sort` is
already a command word in $aveNUS.

Storage functionality for the user's alias shortcuts were also implemented. This means that the shortcuts are conveniently saved
into their hard disk and persist even after the application is closed and restarted.

=== Code contributions:
Here are the https://github.com/AY1920S1-CS2103T-F13-2/main/commits/master?author=seanlowjk[commits],
https://github.com/AY1920S1-CS2103T-F13-2/main/pulls?q=is%3Apr+author%3Aseanlowjk[pull requests] and
https://nus-cs2103-ay1920s1.github.io/tp-dashboard/#search=seanlowjk&sort=groupTitle&sortWithin=title&since=2019-09-06&timeframe=commit&mergegroup=false&groupSelect=groupByRepos&breakdown=false[code]
that I have contributed for this project.
* https://nus-cs2103-ay1920s1.github.io/tp-dashboard/#search=seanlowjk&sort=groupTitle&sortWithin=title&since=2019-09-06&timeframe=commit&mergegroup=false&groupSelect=groupByRepos&breakdown=false[[Project Code Dashboard]]
| https://github.com/AY1920S1-CS2103T-F13-2/main/pulls?q=is%3Apr+author%3Aseanlowjk[[Pull Requests]]

=== Other contributions

* Project Management:

** Added user stories as issues on GitHub

** Reviewed pull requests by team members [Examples: https://github.com/AY1920S1-CS2103T-F13-2/main/pull/80[#1],
https://github.com/AY1920S1-CS2103T-F13-2/main/pull/99[#2]]

Expand Down Expand Up @@ -140,10 +110,21 @@ https://github.com/nus-cs2103-AY1920S1/addressbook-level3/pull/64#pullrequestrev

This section shows the contributions that I have made to the sorting feature of the User Guide.

|===
| _I wrote the commands for `sort`, `makesort`, `customsort`, `autosort` , `viewsort` and `default`.
The commands are shown below while the full user guide can be found
https://ay1920s1-cs2103t-f13-2.github.io/main/UserGuide.html[here]._
|===

include::../UserGuide.adoc[tag=sorting]

== Contributions to the Developer Guide

This section shows the additions that I have made to the sorting feature of the Developer Guide.

|===
| _I wrote the sorting section of the Developer Guide. The full Developer Guide can be found
https://ay1920s1-cs2103t-f13-2.github.io/main/DeveloperGuide.html[here]._
|===

include::../DeveloperGuide.adoc[tag=sorting]

0 comments on commit 13e1ba8

Please sign in to comment.