Update user guide #228
Merged
Update user guide #228
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
Codecov Report
@@ Coverage Diff @@
## master #228 +/- ##
=========================================
Coverage 78.53% 78.53%
Complexity 1155 1155
=========================================
Files 157 157
Lines 3503 3503
Branches 407 407
=========================================
Hits 2751 2751
Misses 611 611
Partials 141 141 Continue to review full report at Codecov.
|
added 4 commits
November 7, 2020 19:49
…into branch-update-UG � Conflicts: � docs/UserGuide.md
docs/UserGuide.md
Outdated
| @@ -40,7 +40,10 @@ | |||
| + [3.4.3.2 Deleting an attendance record for a student: `attendance delete`](#3432-deleting-an-attendance-record-for-a-student-attendance-delete) | |||
| * [3.5 Schedule Feature (By: Alex)](#35-schedule-feature-by-alex) | |||
| + [3.5.1 Viewing lesson schedule: `schedule`](#351-viewing-lesson-schedule-schedule) | |||
| * [3.6 Notes Feature (By: Choon Siong)](#36-notes-feature-by-choon-siong) | |||
| * [3.6 Notebook feature `note` (By: Choon Siong)](#36-notebook-feature-by-choon-siong) | |||
There was a problem hiding this comment.
Since your subheaders already have note included in the command name, I think you could remove it from your 3.6 header for consistency with the rest of the headers at that level
[i.e "3.6 Notebook feature (By: Choon Siong)"]
docs/UserGuide.md
Outdated
| @@ -300,20 +307,21 @@ Examples: | |||
|
|
|||
| #### 3.3.6 Sorting the list of students: `sort` (By: Choon Siong) | |||
|
|
|||
| Sorts the list of students by a specified comparison means. The comparison means must be their name, class time or year. | |||
| You can sort your student list by a specified comparison means. The comparison means must be the student's name, class time or year. | |||
There was a problem hiding this comment.
Do you think "means of comparison" sounds smoother than "comparison means"?
AlexCQY
approved these changes
Nov 8, 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.
images/screenshots)