Skip to content

Commit

Permalink
Update PPP (#225)
Browse files Browse the repository at this point in the history
Update PPP
  • Loading branch information
cutieprobe committed Nov 6, 2019
1 parent 10f9301 commit 565cc46
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 36 deletions.
4 changes: 2 additions & 2 deletions docs/DeveloperGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -572,7 +572,7 @@ has been edited.

// end::export/import[]

// tag::command suggestions[]
// tag::command-suggestion[]
=== Command Suggestion Feature
Users can be forgetful about the command format and sometimes unsure of what arguments to supply.
Auto-suggestion of command arguments while the user keys in inputs can be very helpful to provide user hints.
Expand Down Expand Up @@ -635,7 +635,7 @@ image::CommandPromptActivityDiagram.png[]
* **Alternative 2:** Store arguments of a resource (e.g. `Meme`) as a field of the resource.
** Pros: Easier to implement and cleaner.
** Cons: Irrelevant information needs to be stored as a field (e.g. original file path of a resource).
// end::command suggestions[]
// end::command-suggestion[]

// tag::tabs[]
=== Tabs feature
Expand Down
2 changes: 2 additions & 0 deletions docs/UserGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -461,6 +461,7 @@ Format: `clear`

View various statistics about the memes such as tags and likes count by tags, and most used templates.

// tag::command-suggestion[]
=== Command Suggestions

* Suggestions for command word/argument based on current user input will be displayed in the result box.
Expand Down Expand Up @@ -489,6 +490,7 @@ cute +
CS2103` +
If kbd:[Tab] is pressed, "c" in the command box will be replaced by "CS".

// end::command-suggestion[]
== FAQ

*Q*: How do I transfer my data to another Computer? +
Expand Down
45 changes: 11 additions & 34 deletions docs/team/cutieprobe.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,34 +14,19 @@
== Summary of contributions

* *Major enhancement*: added *the ability to suggest and auto-complete commands*
** What it does: allows the user to undo all previous commands one at a time. Preceding undo commands can be reversed by using the redo command.
** Justification: This feature improves the product significantly because a user can make mistakes in commands and the app should provide a convenient way to rectify them.
** Highlights: This enhancement affects existing commands and commands to be added in future. It required an in-depth analysis of design alternatives. The implementation too was challenging as it required changes to existing commands.
** Credits: _{mention here if you reused any code/ideas from elsewhere or if a third-party library is heavily used in the feature so that a reader can make a more accurate judgement of how much effort went into the feature}_
** What it does: allows the user to type command faster and more easily by showing possible command arguments and allow the user to use TAB key to auto-complete the command.
** Justification: This feature improves the product significantly because a user can be tired of typing the full command over and over again, or unsure of what arguments to supply.
** Highlights: This enhancement affects existing commands and commands to be added in future. It required an in-depth analysis of design alternatives. The implementation too was challenging as it requires live update of input and different methods to process different commands in order to generate suggestions.
** Credits: `LevenshteinDistance` in `org.apache.commons.text` is used in calculating the similarity between strings.

* *Minor enhancement*: added a history command that allows the user to navigate to previous commands using up/down keys.
* *Minor enhancement*:
** Refactored `commands` and `parser` packages by grouping files into sub-packages according to the type of commands. [https://github.com/AY1920S1-CS2103-T16-3/main/pull/114[#114]]

* *Code contributed*: [https://github.com[Functional code]] [https://github.com[Test code]] _{give links to collated code files}_
* *Code contributed*: [https://nus-cs2103-ay1920s1.github.io/tp-dashboard/#search=cutieprobe&sort=groupTitle&sortWithin=title&since=2019-09-06&timeframe=commit&mergegroup=false&groupSelect=groupByRepos&breakdown=false&tabOpen=true&tabType=authorship&tabAuthor=cutieprobe&tabRepo=AY1920S1-CS2103-T16-3%2Fmain%5Bmaster%5D[RepoSense Data]]

* *Other contributions*:

** Project management:
*** Managed releases `v1.3` - `v1.5rc` (3 releases) on GitHub
** Enhancements to existing features:
*** Updated the GUI color scheme (Pull requests https://github.com[#33], https://github.com[#34])
*** Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests https://github.com[#36], https://github.com[#38])
** Documentation:
*** Did cosmetic tweaks to existing contents of the User Guide: https://github.com[#14]
** Community:
*** PRs reviewed (with non-trivial review comments): https://github.com[#12], https://github.com[#32], https://github.com[#19], https://github.com[#42]
*** Contributed to forum discussions (examples: https://github.com[1], https://github.com[2], https://github.com[3], https://github.com[4])
*** Reported bugs and suggestions for other teams in the class (examples: https://github.com[1], https://github.com[2], https://github.com[3])
*** Some parts of the history feature I added was adopted by several other class mates (https://github.com[1], https://github.com[2])
** Tools:
*** Integrated a third party library (Natty) to the project (https://github.com[#42])
*** Integrated a new Github plugin (CircleCI) to the team repo

_{you can add/remove categories in the list above}_
** Update AboutUs, ContactUs and README [https://github.com/AY1920S1-CS2103-T16-3/main/pull/32[#32]]
** Reported bugs and suggestions for other teams [https://github.com/cutieprobe/ped/issues[PED]]

== Contributions to the User Guide

Expand All @@ -50,21 +35,13 @@ _{you can add/remove categories in the list above}_
|_Given below are sections I contributed to the User Guide. They showcase my ability to write documentation targeting end-users._
|===

include::../UserGuide.adoc[tag=delete]
include::../UserGuide.adoc[tag=command-suggestion]

== Contributions to the Developer Guide

|===
|_Given below are sections I contributed to the Developer Guide. They showcase my ability to write technical documentation and the technical depth of my contributions to the project._
|===

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

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


== PROJECT: PowerPointLabs

---
include::../DeveloperGuide.adoc[tag=command-suggestion]

_{Optionally, you may include other projects in your portfolio.}_

0 comments on commit 565cc46

Please sign in to comment.