User guide update #231
Merged
User guide update #231
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
MerlinLim
commented
Nov 6, 2020
MerlinLim
commented
- Restructure order of commands (shift View Command)
- Ensure e.g add commands work
- Fix grammar and Styling
- Fix date time format
- Phrasing of calendar list to schedule - Specify to use Java 11 only - Date format to dd-MM-yyyy HH:mm - Restructure viewing command position - Grammar mistakes
chrystalquek
reviewed
Nov 6, 2020
|
|
||
| * **`delete`**`1` : If in meeting mode, deletes the 1st meeting shown. | ||
| 1. **`delete`** `1` : Deletes the 1st deliverable shown. |
There was a problem hiding this comment.
just in case, maybe better to leave the "if in .. mode"
There was a problem hiding this comment.
I feel like its alright, actually if i wanted to really include I should be including that condition for "add t/deliverable..." instead
docs/UserGuide.md
Outdated
| e.g. in `add n/NAME`, `NAME` is a parameter for the name field `n`, which can be used as `add n/Jason`. | ||
| e.g. in `add n/NAME`, `NAME` is a parameter for the name field `n`, which can be used as `add n/Jason`.<br> | ||
| :bulb: **Tip:** If you are not sure what specific parameter to supply for any of the required fields, supply an estimate or random value as place holder.<br> | ||
| :bulb: **Tip:** For any fields with an unspecified maximum length, the display may look untidy if you supply a long parameter. |
There was a problem hiding this comment.
more like a note.
maybe can say that the list view will be truncated for fields with long parameters
| * `INDEX` must be a positive integer. | ||
|
|
||
| Example: | ||
| * `view 2` views the 2nd deliverable in your displayed deliverable list. |
There was a problem hiding this comment.
actually this is a bit weird, should it be displays or some other word
There was a problem hiding this comment.
yeah it is abit weird but im not sure what else to leave it as. Its not wrong tho
docs/UserGuide.md
Outdated
| * `CONTACTS` is a comma-separated string of names. | ||
| * `LOCATION` is the location of the meeting. | ||
|
|
||
| <div markdown="block" class="alert alert-info"> | ||
|
|
||
| **:information_source: Notes:**<br> | ||
|
|
||
| * Meeting timings may overlap as you may wish to send a representative for your clashing meetings. | ||
| * Different meeting may have overlapping timings as you may wish to send a representative for your clashing meetings. |
chrystalquek
reviewed
Nov 6, 2020
docs/UserGuide.md
Outdated
| adds a meeting with the title `User research review`, start date time `15-12-2020 13:00`, | ||
| end date time `15-12-2020 15:00`, and location `Meeting room A`. | ||
| end date time `15:00`, and location `Meeting room A`. |
Long parameters will be truncated
Productiv
automation
moved this from PRs Pending Approvals
to PRs approved / Ready for Testing
Nov 6, 2020
Resolve user guide merge conflicts.
Productiv
automation
moved this from PRs approved / Ready for Testing
to Issues Done / PRs Merged (After Testing)
Nov 6, 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.