-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update certain aspects of UG #282
Conversation
Removed erroneous references to 'person' Updated list-tag image
docs/UserGuide.md
Outdated
* only full words will be matched. e.g. `Han` will not match `Hans` | ||
* you can specify multiple words you would like to match. e.g. `n/Hans John` | ||
* a match is found if the contact's name has at least one of the keywords (i.e. `OR` search). | ||
* The order of the name keywords does not matter. e.g. `Hans Bo` will match `Bo Hans` e.g. `Hans Bo` will return `Hans Gruber`, `Bo Yang` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
all other points are not capitalised so this one shouldn't be either
docs/UserGuide.md
Outdated
#### Viewing tag tree (coming soon) - `viewtagtree` | ||
|
||
Displays a visual representation of tag-to-tag relationships that currently exist in Athena. This upcoming feature will allow users to easily understand the current tag structure that they have built. | ||
|
||
A preview image is shown below for you to understand what this feature will look like. | ||
![tagtree](images/tagtree-test-tree.png) | ||
|
||
Format: `viewtagtree -t` | ||
* Displays the current tag tree in Athena. | ||
* For each tag, a summary of contacts directly tagged with it is shown. If there are too many contacts, only the first few will be shown together with a number indicating the number of undisplayed contacts. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it might be better to separate this into another section, since grouping it with existing features may be confusing for the user.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done! separated it out. Though it looks slightly awkward now as the upcoming features have to be listed with a coming soon
as specified by the UG requirements.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm!
find command
to be a closer match to the actual implementation in Athenatag tree
,super-tag
to the glossarycoming soon
command forviewtagtree