Skip to content

Commit

Permalink
Merge pull request #239 from yucongkoo/branch-prefix-enhancement
Browse files Browse the repository at this point in the history
Update user guide
  • Loading branch information
LamJiuFong authored Nov 3, 2023
2 parents d0dd51e + 6a76314 commit 8de441d
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,10 @@ will be using these names to refer to the section specified in the following Use
* Parameters can be in any order.<br>
e.g. if the command specifies `n/<name> p/<phone number>`, `p/12341234 n/John` is also acceptable.

* Prefixes (i.e. n/, p/, e/, etc) are designed to be short, however, we do still provide the functionality to detect
full-name prefixes and they can be used interchangeably(e.g. n/ and name/ are interchangeable),
click [here](#prefix-to-full-name-prefix-translation-table) to see a full table of prefix to full-name prefix relation.

* Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.<br>
e.g. if the command is `help 123`, it will be interpreted as `help`.

Expand Down Expand Up @@ -554,6 +558,28 @@ command box.
| **Help** | `help` |
| **Exit** | `exit` |


#### Prefix to full-name prefix translation table

**Note that prefixes are not case sensitive**
| Prefix | Full-name prefix |
|--------|------------------|
| n/ | name/ |
| p/ | phone/ |
| e/ | email/ |
|a/|address/|
|pr/|priority/|
|t/|tag/|
|i/|insurance/|
|r/|remark/|
|at/|addtag/|
|dt/|deletetag/|
|ai/|addinsurance/|
|di/|deleteinsurance/|
|d/|date/|
|t/|time/|
|v/|venue/|

-----------------------------------------------------------------------------------------------------------------------
## Glossary

Expand Down

0 comments on commit 8de441d

Please sign in to comment.