Add user guide for tags. #21
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add Wang Luo's information to AboutUs
Add about us
Revert "Update dg"
docs/UserGuide.md
Outdated
| #### Editing a tag: `tag edit` | ||
|
|
||
| Edits an existing tag in the StonkBook to the specified tag name. All entries previously associated with this tag will be updated to associated with the updated tag. |
There was a problem hiding this comment.
Suggested change
| Edits an existing tag in the StonkBook to the specified tag name. All entries previously associated with this tag will be updated to associated with the updated tag. | |
| Edits an existing tag in StonksBook to the specified tag name. All entries previously associated with this tag will be updated to associated with the updated tag. |
I think we can remove the here
docs/UserGuide.md
Outdated
| * Edits the name of the tag at the specified `INDEX` to be the specified `NAME`. The `INDEX` refers to the index number shown in the list displayed by the `tag list` command. | ||
| * The `INDEX` must be a positive integer 1, 2, 3, ... | ||
| * The `NAME` and `INDEX` fields must be provided. | ||
| * All contacts that have been previously associated with this tag will be updated automatically to associate with the updated tag. |
There was a problem hiding this comment.
Suggested change
| * All contacts that have been previously associated with this tag will be updated automatically to associate with the updated tag. | |
| * All contacts that have been previously associated with this tag will be updated automatically to be associated with the updated tag. |
docs/UserGuide.md
Outdated
|
|
||
| Examples: | ||
|
|
||
| * `tag edit 1 n/close friends` updates the tag `friends` to `close friends`. |
There was a problem hiding this comment.
Should we mention friends here? I think it may be better if you just mention that it updates the name of the first tag (as per tag list)
docs/UserGuide.md
Outdated
|
|
||
| Examples: | ||
|
|
||
| * `tag delete 1` deletes the tag `friends` from the tag list. |
There was a problem hiding this comment.
Same comment for here (about whether to mention friends)
|
|
||
| Format: `tag find INDEX [MODEL]` | ||
|
|
||
| * Displays all entries of `[MODEL]` (optional, see point 3 below) associated with the tag at `INDEX`. The `INDEX` refers to the index number shown in the list displayed by the `tag list` command and `[MODEL]` refers to the model to search for (i.e. contacts, sales, etc.). |
There was a problem hiding this comment.
Maybe we should consider switching to an ordered list if we're going to make reference to other points
sebastiantoh
approved these changes
Sep 27, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
#3