Fix UG errors #314
Merged
Fix UG errors #314
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
jamessinmaojun
added
type.Task
jamessinmaojun
requested review from
Joshy837,
chiageng,
jannaleong and
yleeyilin
Closed
yleeyilin
reviewed
Apr 13, 2024
| <br> | ||
|
|
||
| <div style="text-align:center;"> | ||
| <br> | ||
| <img src="images/ug-images/error-images/invalidField.png" alt="Add before" style="width:100%;"/> | ||
| <medium>Image depicting a help command with an invalid field error message.</medium> | ||
| <medium>Image depicting a `help` command with its invalid field error message.</medium> |
There was a problem hiding this comment.
standardise the following:
- Image .... with "its" invalid field error message.
- Image .... with "the" unknown command error message.
to decide to use either "its" or "the"
There was a problem hiding this comment.
"its" was used for invalid and missing fields, in which the error message is dependent on the field itself. "the" was used for unknown commands, which only has one error message.
docs/UserGuide.md
Outdated
| If you encounter an invalid field error, please ensure the field entered is a valid field for the command you | ||
| are using. Below is an example of a command with an invalid field and the corresponding error message. | ||
| If you encounter an invalid field error, please ensure that the field entered is a valid field for the command you | ||
| are using. Refer to our [Command Summary](#command-summary) for a list of valid fields for each PoochPlanner command. Below is an example of a command with an invalid field and the corresponding error message. |
docs/UserGuide.md
Outdated
| </div> | ||
|
|
||
| <div markdown="span" class="alert alert-primary">:bulb: **Tips:**<br> | ||
| <div markdown="block" class="alert alert-primary">:bulb: **Tips:**<br> | ||
|
|
||
| * For your convenience, if there are repeated fields, only the value of the latest repeated field will be processed. So, if you have mistakenly entered the wrong value, simply retype the field and value in the same line.<br> |
There was a problem hiding this comment.
You can conveniently rectify your mistake by retyping the field and value in your command as only the latest field will be processed.
Joshy837
approved these changes
Apr 14, 2024
| <br> | ||
|
|
||
| <div style="text-align:center;"> | ||
| <br> | ||
| <img src="images/ug-images/error-images/invalidField.png" alt="Add before" style="width:100%;"/> | ||
| <medium>Image depicting a help command with an invalid field error message.</medium> | ||
| <medium>Image depicting a `help` command with its invalid field error message.</medium> |
jannaleong
approved these changes
Apr 14, 2024
| `Multiple values specified for the following single-valued field(s): ; [duplicated field] :`<br> | ||
| * Example of a search command with a duplicated search field: | ||
| * `/search ; name : Pooch ; name : Pooch` | ||
| </div> | ||
|
|
There was a problem hiding this comment.
deos this search need the duplicate field line too? the for your convenience ...
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.
Error not fixed:
All screenshots depict the db file to be
PoochPlanner.jsonwhen in actuality it is implemented aspoochplanner.json. Either fix all screenshots or change the file name.