Skip to content

Commit

Permalink
Merge pull request #332 from tituschewxj/fix-docs-3
Browse files Browse the repository at this point in the history
docs: Fix docs
  • Loading branch information
tituschewxj authored Apr 15, 2024
2 parents 65bfd00 + 2e6f0f4 commit 9e01ef4
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 8 deletions.
15 changes: 9 additions & 6 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -584,8 +584,8 @@ The following activity diagram summarizes what happens when a user executes a ne
| {{ threeStars }} | attendance tracking TA | unmark attendance for a student in my class for a particular week | keep track of who is absent |
| {{ twoStars }} | TA over multiple semesters | delete all students from a previous semester from the contact book | clear my contacts quickly at the start of a semester |
| {{ twoStars }} | new user | know all the commands of TAPro via the help window | use it effectively |
| {{ twoStars }} | TA comfortable with CLI | retrieve command history | avoid retyping a command |
| {{ twoStars }} | TA comfortable with CLI | autocomplete my input | save time |
| {{ twoStars }} | user comfortable with CLI | retrieve command history | avoid retyping a command |
| {{ twoStars }} | user comfortable with CLI | autocomplete my input | save time |
| {{ twoStars }} | fast typist | use keyboard inputs to interact with TAPro | save time |
| {{ twoStars }} | user | exit the program smoothly | save time |
| {{ oneStar }} | user | easily read the result message of a command | save time |
Expand Down Expand Up @@ -844,6 +844,7 @@ For all use cases below, the **System** is TAPro and the **Actor** is the user,
2. User presses the autocompletion hotkey.

3. Autocompleted command is shown in the command box.

Use case ends.

<span class="semi-bold">Extensions</span>
Expand All @@ -867,6 +868,7 @@ For all use cases below, the **System** is TAPro and the **Actor** is the user,
2. User presses the retrieve previous command hotkey.

3. TAPro displays the successful command input in the command box.

Use case ends.

<span class="semi-bold">Extensions</span>
Expand All @@ -890,6 +892,7 @@ For all use cases below, the **System** is TAPro and the **Actor** is the user,
2. User presses the retrieve next command hotkey.

3. TAPro displays a more recent successful command input in the command box.

Use case ends.

<span class="semi-bold">Extensions</span>
Expand Down Expand Up @@ -1120,7 +1123,7 @@ delstu E0123456
find john
```

<span class="semi-bold">Expected:</span> Student with name 'John Doe' is displayed on the Student Contact Cards Panel.
<span class="semi-bold">Expected:</span> Student with name 'John Doe' is displayed on the student contact cards panel.
</box>

<box type="wrong" light>
Expand Down Expand Up @@ -1463,7 +1466,7 @@ clear
</box>
<br>

6. **Why does command history toggle only retrieve successful commands?**
6. **Why does command history retrieval only retrieve successful commands?**
1. The alternative we considered was to store the history of all command inputs.
2. However, unsuccessful command inputs are not that helpful to a user, and it only clutters up a user's command history, resulting in more time wasted searching for a successful command input.
3. Hence, storing only successful command inputs in the command history enabled users to be more efficient at using TAPro.
Expand Down Expand Up @@ -1505,8 +1508,8 @@ Below are some non-exhaustive instances of our challenges, achievements and effo

1. Refactored the parameter syntax to improve AB3's original OOP.

1. Implemented autocomplete and command history.
We thought hard about what are the potential shortcuts that would save our target user's time and we looked to
1. Implemented autocomplete and command history retrieval.
We thought hard about what are the potential shortcuts that would save our target user's time, and we looked to
the CLI for inspiration. Given that our product uses NUSNet ID as its unique identifier, it can be a hassle to
type out a full command. Especially when it has already been previously used, or only require minor changes to
the command. This resulted in the idea of clicking {{ macros.keyFormat
Expand Down
2 changes: 1 addition & 1 deletion docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -1281,7 +1281,7 @@ Adding new tag(s) will replace the existing tag(s).

**Q**: <span class="semi-bold">How can I save more time when using TAPro?</span>

**A**: You can use the advanced features like **[autocomplete](#autocomplete)** and **[command history toggle](#retrieving-command-history)** in TAPro!
**A**: You can use the advanced features like **[autocomplete](#autocomplete)** and **[command history retrieval](#retrieving-command-history)** in TAPro!
These
features are
designed to help you input commands faster and more efficiently.
Expand Down
3 changes: 2 additions & 1 deletion docs/_markbind/layouts/default.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,9 @@
* [User Guide]({{ baseUrl }}/UserGuide.html) :expanded:
* [Quick Start]({{ baseUrl }}/UserGuide.html#quick-start)
* [Features]({{ baseUrl }}/UserGuide.html#features)
* [Command summary]({{ baseUrl }}/UserGuide.html#command-summary)
* [Known issues]({{ baseUrl }}/UserGuide.html#known-issues)
* [FAQ]({{ baseUrl }}/UserGuide.html#faq)
* [Command Summary]({{ baseUrl }}/UserGuide.html#faq)
* [Developer Guide]({{ baseUrl }}/DeveloperGuide.html) :expanded:
* [Acknowledgements]({{ baseUrl }}/DeveloperGuide.html#acknowledgements)
* [Setting Up]({{ baseUrl }}/DeveloperGuide.html#setting-up-getting-started)
Expand Down

0 comments on commit 9e01ef4

Please sign in to comment.