Update ug format #181
Update ug format #181
Conversation
Codecov Report
@@ Coverage Diff @@
## master #181 +/- ##
=========================================
Coverage 73.18% 73.18%
Complexity 476 476
=========================================
Files 80 80
Lines 1473 1473
Branches 150 150
=========================================
Hits 1078 1078
Misses 342 342
Partials 53 53 Continue to review full report at Codecov.
|
docs/UserGuide.md
Outdated
|
|
||
| <div markdown="block" class="alert alert-info"> | ||
|
|
||
| **:information_source: Provides additional notes and constraints for certain information.**<br> |
There was a problem hiding this comment.
i think you can delete the <br> at the end of this line cos it makes the spacing off
docs/UserGuide.md
Outdated
|
|
||
| ## FAQ | ||
|
|
||
| **Q**: How do I transfer my data to another Computer?<br> | ||
| **A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous ZooKeep home folder. | ||
|
|
||
| **Q**: Can I record the feeding times of a specific animal in any order I prefer? |
docs/UserGuide.md
Outdated
| **Q**: Can I record the feeding times of a specific animal in any order I prefer? | ||
| **A**: The feeding time will be arranged in chronological order regardless of the order entered for easier reference. | ||
|
|
||
| **Q**: Can I search for animals based on a certain alphabet or half specified keywords? |
| **A**: The feeding time will be arranged in chronological order regardless of the order entered for easier reference. | ||
|
|
||
| **Q**: Can I search for animals based on a certain alphabet or half specified keywords? | ||
| **A**: The find feature will only list animals with the exact specified keyword provided. |
There was a problem hiding this comment.
maybe can include that it is case insensitive?
There was a problem hiding this comment.
I think i placed it as a tip under the find feature, thanks anyways!
docs/UserGuide.md
Outdated
| <br> Here are some example commands you can try: | ||
|
|
||
| * **`list`** : Lists all animals. | ||
| * **`exit`** : Exits the app. | ||
|
|
||
| 1. Refer to the [Features](#features) below for details of each command. | ||
| 1. You can refer to the [Features](#features) below for the details of each command. The features are categorised in alphabetical order for easier reference. |
There was a problem hiding this comment.
Minor nitpick in language. "listed" instead of "categorised".
|
Just a thought, is listing the features alphabetically the best bet? Currently it references the less "basic" features first like "append". Furthermore these features reference features that are later down the list, meaning the user would not have read them yet. Shall we consider listing from basic to advanced? |
docs/UserGuide.md
Outdated
|
|
||
| ## Legend | ||
|
|
||
| <div markdown="block" class="alert alert-info"> |
There was a problem hiding this comment.
sorry i think the reason why the spacing is weird is bc it is a block. could you change it to try changing it to markdown="span"?
Made some readjustments to the UGs as much as possible according to the review comments.
Resolves #158
Resolves #159
Resolves #161
Resolves #163
Resolves #165
Resolves #166