Skip to content

Commit

Permalink
Improve space usage
Browse files Browse the repository at this point in the history
  • Loading branch information
wxwern committed Nov 13, 2023
1 parent 4e64e94 commit 3b16951
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions docs/team/wxwern.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,11 @@ Given below are my contributions to the project.

* **New Feature**: Command Autocompletion

* This allows users to autocomplete their commands, just like command terminals or programming IDEs, such as by pressing **TAB**.
* This allows users to autocomplete their commands, just like command terminals or programming IDEs, such as by pressing **TAB**, and even undo when you **BACKSPACE**.

* Like an IDE, it does a _subsequence_ match, so typing `-dsp` then **TAB** can select `--description`, allowing for fast disambiguation from another similar term like `--descending`.

* As a bonus, it also supports undoing with **BACKSPACE**. It keeps a complete undo history, so you can invoke multiple undos with repeated **BACKSPACE** keystrokes if you only edited text on the trailing (right) side of the command input.

* **Rationale:** It allows for faster command input, and reduces the need to memorize the exact command syntax.
* **Rationale:** It allows for faster command input, and reduces command syntax memorization.

* **Implementation:** The internal implementation is written completely from scratch. This allows it to:

Expand Down Expand Up @@ -47,21 +45,22 @@ Given below are my contributions to the project.
* Tweaking the page-break rules for different elements, such as preventing page breaks on crucial boxes or enforcing page breaks immediately after certain headers.

* Styling custom unified UG elements, like the following:
* <span class="learning-outcome pill">:trophy: How to perform a task</span> <span class="information pill">:information_source: An info message pill</span>
* <span class="warning pill">:warning: A warning message pill</span> <span class="danger pill">:warning: A danger message pill</span>
* <span class="beginner pill">Beginner</span> <span class="intermediate pill">Intermediate</span> <span class="expert pill">Expert</span>
* <span class="learning-outcome pill">:trophy: How to perform a task</span> <span class="information pill">:information_source: An info message pill</span> <span class="warning pill">:warning: A warning message pill</span> <span class="danger pill">:warning: A danger message pill</span>
* <span class="applies-to pill"><span class="jobby-data-class pill">Organization</span> <span class="jobby-data-class pill">Recruiter</span> <span class="jobby-data-class pill">Job Application</span></span>
* <span class="beginner pill">Beginner</span> <span class="intermediate pill">Intermediate</span> <span class="expert pill">Expert</span><br>

* **Enhancements to existing features**:

* Revamped the parameter syntax to use a prefix of `--param`.

* This allows for improved autocompletion UX as compared to `param/`, since we can immediately determine if the user intends to type a parameter based on the first character.

* It is also much less likely to clash with an existing user input.

* Swapped out random ID generation with an implementation to derive IDs from an input name.

* This allows for improved UX when editing details that require an ID, combined with autocomplete integration.

* e.g., `google-sg-a8b3fe` can be derived from an input of `Google SG`.

* **Documentation**:
Expand All @@ -79,7 +78,7 @@ Given below are my contributions to the project.
* Developer Guide:

* Integrated explanations of how "Autocomplete classes" work in the context of the `Logic` package.

* Updated how `AppParser` (formerly `AddressBookParser`) operates in the context of our app, since we now dynamically look up details and also support autocompletion.

* Added a complete high-level explanation of Jobby's internal autocomplete implementation and interactions.
Expand Down

0 comments on commit 3b16951

Please sign in to comment.