-
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
[UG] Update Find Command #174
[UG] Update Find Command #174
Conversation
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
docs/UserGuide.md
Outdated
@@ -58,6 +63,7 @@ Command | Parameters | Description | |||
`delete -OBJECT` | `OBJECT` activity/ accommodation/ person/ travelplan | Deletes the given object type | |||
`edit -OBJECT` | `OBJECT` activity/ accommodation/ person/ travelplan | Edits the details of the given object type | |||
`goto PLAN_NAME` | `PLAN_NAME` nameOfTravelPlan/ wishlist | Navigate to the specific travel plan/ wishlist | |||
`find -OBJECT` | `OBJECT` activity/ accommodation/ person | Finds the given object type whose names contain any of the given keywords |
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.
i think for all the find command in the table, we should change to COMMAND -OBJECT KEYWORD
, then the parameters add in KEYWORD find object that contains this keyword
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.
I did this for my delete command, think we shld do it for all commands on the table. Add the additional parameter for the commands that require it. Like delete -object index
docs/UserGuide.md
Outdated
@@ -58,6 +63,7 @@ Command | Parameters | Description | |||
`delete -OBJECT` | `OBJECT` activity/ accommodation/ person/ travelplan | Deletes the given object type | |||
`edit -OBJECT` | `OBJECT` activity/ accommodation/ person/ travelplan | Edits the details of the given object type | |||
`goto PLAN_NAME` | `PLAN_NAME` nameOfTravelPlan/ wishlist | Navigate to the specific travel plan/ wishlist | |||
`find -OBJECT KEYWORD` | `OBJECT` activity/ accommodation/ person<br/> `KEYWORD` keywords to search for | Finds the given object type whose names contain any of the given keywords |
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.
find friend instead of person?
Codecov Report
@@ Coverage Diff @@
## master #174 +/- ##
============================================
- Coverage 66.17% 65.92% -0.26%
- Complexity 766 768 +2
============================================
Files 116 116
Lines 2510 2512 +2
Branches 309 307 -2
============================================
- Hits 1661 1656 -5
- Misses 724 733 +9
+ Partials 125 123 -2
Continue to review full report at Codecov.
|
No description provided.