diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 7318fdb42ea..3b6b1fb80f6 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -1075,6 +1075,32 @@ This should be treated as an invalid format. Though not strictly wrong, the index parser currently already checks for `+` and treats it as invalid. For consistency, this should also apply to participation. +**Make year 0000 an illegal value for the date** + +**Description** + +Currently, year 0000 is accepted as a valid year. +This should be changed to no longer be valid. + +**Rationale** + +According to Wikipedia, a year 0 does not exist in the Anno Domini calendar year. +Therefore, it should not be allowed. + +**Standardise error messages involving index** + +**Description** + +For some commands, entering specific indexes (like 0) will show an error message +stating that the index is invalid (not an unsigned nonzero integer), while other times +it will show the default error message for incorrect format. + +**Rationale** + +These error messages should be standardised to avoid confusion. +Any errors when parsing the index specifically ideally should specify that the index +specifically is invalid to help the user correct it. + ### Glossary * **Attendance**: Student's Presence/Absence for a Lesson diff --git a/docs/UserGuide.md b/docs/UserGuide.md index f026a9d23ff..9eae12edafe 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -415,7 +415,7 @@ Examples: ### Removing a student from a lesson : `removefromlesson` -Removes student(s) from a lesson.Removing a student will also remove all data associated +Removes student(s) from a lesson. Removing a student will also remove all data associated with them to that lesson, i.e. re-adding them defaults to no attendance and 0 participation. Format: `removefromlesson LESSON_INDEX n/NAME [n/NAME]…` @@ -499,6 +499,8 @@ _Details coming soon ..._ 1. **When using multiple screens**, if you move the application to a secondary screen, and later switch to using only the primary screen, the GUI will open off-screen. The remedy is to delete the `preferences.json` file created by the application before running the application again. 2. **If you minimize the Help Window** and then run the `help` command (or use the `Help` menu, or the keyboard shortcut `F1`) again, the original Help Window will remain minimized, and no new Help Window will appear. The remedy is to manually restore the minimized Help Window. +3. Occasionally, **the consults and lessons list** may not display properly, i.e. have wrong heights. Try using the relevant list command `listconsults` or `listlessons` to refresh the list. Alternatively, try scrolling the list with a mouse. This should update the display to remedy the bug. +4. Certain characters cannot be used in student names, such as `/` or `-`, which prevent legitimate parts of names such as `S/O` from being input. This will be addressed in a future version. -------------------------------------------------------------------------------------------------------------------- @@ -518,14 +520,14 @@ Action | Format, Examples **Import Students** | `import FILENAME`
e.g., `import students.csv` (relative)
e.g., `import ~/Documents/students.csv` (home) **Import Consultations** | `importconsult FILENAME`
e.g., `importconsult sessions.csv` (relative)
e.g., `importconsult ~/Documents/sessions.csv` (home) **Add Consultation** | `addconsult d/DATE t/TIME`
e.g., `addconsult d/2024-10-20 t/14:00` -**Add to Consultation** | `addtoconsult INDEX [n/NAME]…​ [i/STUDENT_INDEX]…​`
e.g., `addtoconsult n/James Jake n/John Jill i/2 i/3` +**Add to Consultation** | `addtoconsult INDEX [n/NAME]…​ [i/STUDENT_INDEX]…​`
e.g., `addtoconsult 1 n/James Jake n/John Jill i/2 i/3` +**Remove from Consultation** | `removefromconsult INDEX n/NAME…​`
e.g., `removefromconsult 1 n/Jake John`
e.g., `removefromconsult 1 n/Jake n/John` **Delete Consultations** | `deleteconsult INDEX [;INDEX]…​`
e.g., `deleteconsult 3`
e.g., `deleteconsult 2;3;4` **List Consultations** | `listconsults` -**Remove from Consultation** | `removefromconsult INDEX n/NAME…​`
e.g., `removefromconsult n/Jake John`
e.g., `removefromconsult n/Jake n/John` **Add Lesson** | `addlesson d/DATE t/TIME`
e.g., `addlesson d/2024-10-20 t/14:00` -**Add to Lesson** | `addtolesson INDEX [n/NAME]…​ [i/STUDENT_INDEX]…​`
e.g., `addtolesson n/James Jake n/John Jill i/2 i/3` +**Add to Lesson** | `addtolesson INDEX [n/NAME]…​ [i/STUDENT_INDEX]…​`
e.g., `addtolesson 1 n/James Jake n/John Jill i/2 i/3` +**Remove from Lesson** | `removefromlesson INDEX n/NAME…​`
e.g., `removefromlesson 1 n/Jake John`
e.g., `removefromlesson 1 n/Jake n/John` **Delete Lesson** | `deletelesson INDEX [;INDEX]…​`
e.g., `deletelesson 3`
e.g., `deletelesson 2;3;4` **List Lessons** | `listlessons` **Mark Attendance for Lesson** | `marka INDEX n/NAME…​ a/ATTENDANCE`
e.g., `marka 3 n/Jack a/y`
e.g., `marka 3 n/Jack n/Jill a/1`
e.g., `marka 3 n/Jack a/n`
e.g., `marka 3 n/Jack a/0` **Mark Participation for Lesson** | `markp INDEX n/NAME…​ pt/POINTS`
e.g., `markp 3 n/Jack pt/75` -**Remove from Lesson** | `removefromlesson INDEX n/NAME…​`
e.g., `removefromlesson n/Jake John`
e.g., `removefromlesson n/Jake n/John`