Update prefix table, add title to user guide #307
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
# Conflicts: # docs/UserGuide.md
Codecov Report
@@ Coverage Diff @@
## master #307 +/- ##
=========================================
Coverage 77.14% 77.14%
Complexity 857 857
=========================================
Files 127 127
Lines 2485 2485
Branches 325 325
=========================================
Hits 1917 1917
Misses 477 477
Partials 91 91 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
kennethk-1201
requested changes
Apr 10, 2023
docs/UserGuide.md
Outdated
| --- | ||
|
|
||
| # **1. Introduction** | ||
|
|
||
| # 1. Introduction |
docs/UserGuide.md
Outdated
| @@ -303,7 +322,7 @@ Examples: | |||
|
|
|||
|
|
|||
|
|
|||
| ### 4.1.5. Find employee by ID: `feid` | |||
| ### 4.1.5. Find employees by ID: `feid` | |||
There was a problem hiding this comment.
should be "employee" because only one employee has the ID
kennethk-1201
requested changes
Apr 10, 2023
docs/UserGuide.md
Outdated
|
|
||
| --- | ||
| * Table of Contents | ||
| {:toc} |
docs/UserGuide.md
Outdated
| |-------------------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | **ID** | id/ | {::nomarkdown} ID is the unique identifier for an employee. Leading zeroes are ignored. <br/> **Note: This flag is only used when adding an employee into the app**. <br/> It has the following constraints: <br/> <ul> <li> Must be a positive integer <ol> <li> 0 is often reserved for administrative use </li> <li> negative numbers are not conventionally used </li> </ol> </li> <li> Cannot be empty </li> </ul> <br/> Valid Examples: <ul> <li>1</li> <li>100</li> </ul> Invalid Examples: <ul> <li>Bob</li> <li>0</li> <li>-1</li> </ul> {:/} | | ||
| | **ID** | id/ | {::nomarkdown} ID is the unique identifier for an employee. Leading zeroes are ignored. <br/> **Note**: This flag is only used when adding an employee into the app. <br/> It has the following constraints: <br/> <ul> <li> Must be a positive integer <ol> <li> 0 is often reserved for administrative use </li> <li> negative numbers are not conventionally used </li> </ol> </li> <li> Cannot be empty </li> </ul> <br/> Valid Examples: <ul> <li>1</li> <li>100</li> <li>001000</li> </ul> Invalid Examples: <ul> <li>Bob</li> <li>0</li> <li>-1</li> </ul> | | ||
| | **EMPLOYEE_ID** | eid/ | Similar to ID, The EMPLOYEE_ID represents the ID of an employee. <br/> It is used for any commands that require referencing an employee. <br/> It follows the same constraints as ID. {:/} | |
kennethk-1201
approved these changes
Apr 10, 2023
# Conflicts: # docs/UserGuide.md
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.
No description provided.