Skip to content
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

Merged
merged 4 commits into from
Nov 9, 2020

Conversation

chan-j-d
Copy link
Collaborator

@chan-j-d chan-j-d commented Nov 9, 2020

  • redid find command to be a closer match to the actual implementation in Athena
  • added the terms tag tree, super-tag to the glossary
  • added coming soon command for viewtagtree
  • removed some erroneous references to 'person' and 'addressbook' instead of 'contact' and 'athena'

@chan-j-d chan-j-d added the type.UG Issues regarding the UserGuide document. label Nov 9, 2020
@chan-j-d chan-j-d added this to the v1.4 milestone Nov 9, 2020
@chan-j-d chan-j-d self-assigned this Nov 9, 2020
* 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`
Copy link

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

Comment on lines 593 to 603
#### 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.

Copy link

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.

Copy link
Collaborator Author

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.

@chan-j-d chan-j-d requested a review from fyshhh November 9, 2020 06:30
Copy link

@fyshhh fyshhh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!

@fyshhh fyshhh merged commit db65bd1 into AY2021S1-CS2103T-W10-4:master Nov 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type.UG Issues regarding the UserGuide document.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants