From 7fec40f24703d170688309a2963713ce55627ca4 Mon Sep 17 00:00:00 2001 From: Xuan Yi Date: Thu, 5 Oct 2023 02:30:44 +0800 Subject: [PATCH 1/8] Add delete-s command to UG --- docs/UserGuide.md | 106 ++++++++++++++++++++------------- docs/images/deleteSchedule.png | Bin 0 -> 5244 bytes 2 files changed, 64 insertions(+), 42 deletions(-) create mode 100644 docs/images/deleteSchedule.png diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 755aae6e23a..b94e7d935dc 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -15,7 +15,7 @@ Here’s an overview of what you can do with Tutor Connect: On top of these functionalities, we believe that tuition centre management must be efficient. Therefore, Tutor Connect is **optimised for users who can type fast** and utilise the Command Line Interface (CLI) to complete tasks using the keyboard faster than using the mouse. * Table of Contents -{:toc} + {:toc} -------------------------------------------------------------------------------------------------------------------- @@ -50,11 +50,11 @@ On top of these functionalities, we believe that tuition centre management must ## Quick Start 1. Ensure you have Java `11` installed in your Computer. To verify, perform the following steps: - 1. Open a terminal. Refer to the following guides on how: - 1. [MacOS](https://support.apple.com/en-sg/guide/terminal/apd5265185d-f365-44cb-8b09-71a064a42125/mac#:~:text=Terminal%20for%20me-,Open%20Terminal,%2C%20then%20double%2Dclick%20Terminal) - 2. [Windows](https://www.howtogeek.com/235101/10-ways-to-open-the-command-prompt-in-windows-10/#:~:text=anywhere%20you%20like.-,Open%20Command%20Prompt%20from%20the%20Run%20Box,open%20an%20administrator%20Command%20Prompt) - 2. Type `java -version` and press Enter. - 3. If it says a version other than 11 or `command not found`, please install Java 11 by following this [guide](https://www.java.com/en/download/help/download_options.html). + 1. Open a terminal. Refer to the following guides on how: + 1. [MacOS](https://support.apple.com/en-sg/guide/terminal/apd5265185d-f365-44cb-8b09-71a064a42125/mac#:~:text=Terminal%20for%20me-,Open%20Terminal,%2C%20then%20double%2Dclick%20Terminal) + 2. [Windows](https://www.howtogeek.com/235101/10-ways-to-open-the-command-prompt-in-windows-10/#:~:text=anywhere%20you%20like.-,Open%20Command%20Prompt%20from%20the%20Run%20Box,open%20an%20administrator%20Command%20Prompt) + 2. Type `java -version` and press Enter. + 3. If it says a version other than 11 or `command not found`, please install Java 11 by following this [guide](https://www.java.com/en/download/help/download_options.html). 2. Download the latest jar file (tutorconnect.jar) from our [Github Releases](https://github.com/AY2324S1-CS2103T-T17-3/tp/releases). @@ -63,14 +63,14 @@ On top of these functionalities, we believe that tuition centre management must 4. Double-click the jar file to launch the application.
- - **:information_source: Mac Users**
- - If you are a Mac user, you may encounter a warning that says - the jar file cannot be opened because it is from an unidentified developer. To continue: - - 1. Right-click on the jar file and select `Open With > JavaLauncher (default)` - 2. Press Open when prompted + + **:information_source: Mac Users**
+ + If you are a Mac user, you may encounter a warning that says + the jar file cannot be opened because it is from an unidentified developer. To continue: + + 1. Right-click on the jar file and select `Open With > JavaLauncher (default)` + 2. Press Open when prompted
@@ -85,16 +85,16 @@ On top of these functionalities, we believe that tuition centre management must **:information_source: Command Format:**
* Words in `UPPER_CASE` are the parameters to be supplied by the user.
- e.g. in `add n/NAME`, `NAME` is a parameter which can be used as `add n/John Doe`. + e.g. in `add n/NAME`, `NAME` is a parameter which can be used as `add n/John Doe`. * Items in square brackets are optional.
- e.g `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`. + e.g `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`. * Items with `…`​ after them can be used multiple times including zero times.
- e.g. `[t/TAG]…​` can be used as ` ` (i.e. 0 times), `t/friend`, `t/friend t/family` etc. + e.g. `[t/TAG]…​` can be used as ` ` (i.e. 0 times), `t/friend`, `t/friend t/family` etc. * Parameters can be in any order.
- e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable. -* Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) + e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable. +* Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.
- e.g. if the command specifies `help 123`, it will be interpreted as `help`. + e.g. if the command specifies `help 123`, it will be interpreted as `help`. * If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application. @@ -113,19 +113,19 @@ Example: * `add-t n/Betsy Crowe p/91234567 e/betsycrowe@example.com` Acceptable values for each parameter: -* `NAME`: Only string input accepted -* `PHONE`: NUMBER Only numerical input +* `NAME`: Only string input accepted +* `PHONE`: NUMBER Only numerical input * `EMAIL`: Only valid email addresses Expected output: * `New tutor John Doe 98765432 johnd@example.com has been added.` Error messages: -* `Missing parameter: n/`: The tag n/ is missing or tutor’s name is missing. -* `Missing parameter: p/`: The tag p/ is missing or tutor’s phone number is missing. -* `Missing parameter: e/`: The tag e/ is missing or tutor’s email is missing. -* `Wrong input: n/`: The name entered is not a valid string. -* `Wrong input: p/`: The phone number entered does not consist of numbers only. +* `Missing parameter: n/`: The tag n/ is missing or tutor’s name is missing. +* `Missing parameter: p/`: The tag p/ is missing or tutor’s phone number is missing. +* `Missing parameter: e/`: The tag e/ is missing or tutor’s email is missing. +* `Wrong input: n/`: The name entered is not a valid string. +* `Wrong input: p/`: The phone number entered does not consist of numbers only. * `Wrong input: e/`: The email entered is invalid. ### Adding a schedule: `add-s` @@ -146,9 +146,9 @@ Adds a schedule to a specified tutor. * `END_TIME`: Only datetime in `yyyy-MM-ddTHH:mm:ss` format is accepted
- - **:information_source: Information**
- + + **:information_source: Information**
+ * `yyyy` represents the **year** (e.g., 2023). * `MM` represents the **month** with a leading zero (e.g., 09 for September, 10 for October). * `dd` represents the **day** of the month with a leading zero (e.g., 03, 15). @@ -156,7 +156,7 @@ Adds a schedule to a specified tutor. * `HH` represents the **hour** in **24-hour format** with a leading zero (e.g., 09 for 9 AM, 21 for 9 PM). * `mm` represents the **minutes** with a leading zero (e.g., 05). * `ss` represents the **seconds** with a leading zero (e.g., 05). - +
**Expected output**: @@ -171,9 +171,31 @@ Adds a schedule to a specified tutor. * `Wrong input: s/`: The start time entered is not in datetime format. * `Wrong input: e/`: The end time entered is not in datetime format.. +### Deleting a schedule: `delete-s` + +Deletes a schedule in the address book based on their index number in the table of schedules listed. + +![delete schedule](images/deleteSchedule.png) + +Format: `delete-s INDEX_NO` + +Example: +* `delele-s 5` deletes the schedule that is indexed as 5 in the schedule list. +* `list` followed by `delete-s 2` deletes the 2nd schedule in the schedule list. + +Acceptable values for each parameter: +* `INDEX_NO`: NUMBER Only numerical input that ranges from 1 to the last schedule shown in the list of schedules + +Expected output: +* `Schedule has been deleted: Tutor: John Doe; Start date: Sep 15, 2023 09:00; End date: Sep 15, 2023 11:00;` + +Error messages: +* `Index number given is out of range`: Given index is out of range. +* `Invalid value in parameter INDEX_NO`: Parameter given is not a numerical value. +* `Missing parameter INDEX_NO`: A numerical value is not provided when calling the command `delete-s`. -_Details coming soon ..._ +_More details coming soon ..._ -------------------------------------------------------------------------------------------------------------------- @@ -192,13 +214,13 @@ _Details coming soon ..._ ## Command summary -| Action | Format, Examples | -|------------------|-----------------------------------------------------------------------------------------------------------------------------| -| **Add Tutor** | `add-t n/NAME p/PHONE NUMBER e/EMAIL`
e.g., `add-t n/John Doe p/98765432 e/johnd@example.com` | -| **Add Schedule** | `add-s ti/TUTOR_INDEX s/START_TIME e/END_TIME`
e.g., `add-s ti/1 s/2023-09-15T09:00:00 e/2023-09-15T11:00:00` | -| **Clear** | `clear` | -| **Delete** | `delete INDEX`
e.g., `delete 3` | -| **Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`
e.g.,`edit 2 n/James Lee e/jameslee@example.com` | -| **Find** | `find KEYWORD [MORE_KEYWORDS]`
e.g., `find James Jake` | -| **List** | `list` | -| **Help** | `help` | +| Action | Format, Examples | +|---------------------|-----------------------------------------------------------------------------------------------------------------------------| +| **Add Tutor** | `add-t n/NAME p/PHONE NUMBER e/EMAIL`
e.g., `add-t n/John Doe p/98765432 e/johnd@example.com` | +| **Add Schedule** | `add-s ti/TUTOR_INDEX s/START_TIME e/END_TIME`
e.g., `add-s ti/1 s/2023-09-15T09:00:00 e/2023-09-15T11:00:00` | +| **List Schedule** | `list-s` | +| **Delete Schedule** | `delete-s INDEX_NO`
e.g., `delete-s 3` | +| **Clear** | `clear` | +| **Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`
e.g.,`edit 2 n/James Lee e/jameslee@example.com` | +| **Find** | `find KEYWORD [MORE_KEYWORDS]`
e.g., `find James Jake` | +| **Help** | `help` | diff --git a/docs/images/deleteSchedule.png b/docs/images/deleteSchedule.png new file mode 100644 index 0000000000000000000000000000000000000000..58492e8f1b895bbd2ef6b2d9a44494b725c83f8e GIT binary patch literal 5244 zcmdT|XH-+$w$8C}1O(}VKosH7L3$@5gsLDl2mzGdkpv7Kl>W0r0CS6e+VG-+_GkqMu**e-%^ z8?rgevInUKu^CvJnwkBIeTfL#vjPBK`Eo6jE#-IQhycJ&Ir1CY1$F@73k8e@0QhlP zjsgJq`8tz4siOydzX1RNca}^2k9QWAmhytg=4SLin*O(^-7dMW=UV8>k5)DLNqgdC zCn&N0yA|@hDPm=J$T1K^-@$u)rPa9EPg-VR#8O|cL0?6uuxkLoqX^$v{4*Py`-7ry zp4AN9E(yBG3L>wbvw>9~-NF9!^~tmA*`>g>L&`|O&l#N4BkfD^0lPW7ri~d^@UJ;) zJ|7{%CoAJsWrJgS=7}ucAYdNWq8(JIU`iMf*zPj9c1& zAlB1Gb=*TM;4+&iEsWj7Q> zEId9#)C#p!4c1AilopQj8Kw9Q-}-QlNeRL8HHH&z9>k@iL1&%?R+j*;(ud>W6{C~$ zL!W}^SS?~g9$3^wg=QCg+}0Fz8BI#BO=5(27w6axSdN2&+m^6 zP~~PPagaL~kdSx1*);TQQup4oUR&25Rk(Yw<{q*#7pJyl5*MIq%NaX6)!v-UGYbGb z3tH=xQ-`Q19R38?FoRT``GqhQ2?l|^ipTd%CpFBoSXz+xn#sBM{%nV|Ia(_WOq{8A z^wzD)z)9rPKDh(7bOu)c1IY=NEjXc79Ux zlk@i%l;8XdydD(^{Q|o0zXJU)WIsBe?pj>TwIq+gSJ}`|m_qq?FMq-RlQ5+}7jO)X zzXJgGWqSUi*S{Ym^(XaeZ*R;m_o)jlAryX}pTYX{cb=0espdQJrIG1h@bOn@|CYXU z42$e@En4W@lr1h|lppgRl}u&2WwB#eoRLI{p94K-19B=Dz8;zC9BO$k9%w>wR${-o z9qunogvefZ{zjM{NrC@))_tYpYNfNcu9u@-072Hp+wxGgk*I=YAk95&gD+Z4q2rYf z1DPoB(P=+_JoI?{nOT=>GeK|hHh&k9XOlL~Ew!TGi5ls}xqir{?zI&4$o^{W<0QtX zY5qAzC*Q5qrJ1KK5iu>AEI*o3*JWPepQ(nA!nRHu&@2Vt z##8p&xTn3HTpIQ#!ENx?LR5Sss@n13h^S=l^wP~t>QPqTiO?USTqka4T*-1d3aV$t z8M3&;H^IsyKvQK`&fF8>u5au4&(;gGk`n{@Zf*V%4hiby&?B&U4=YB$dA{zt&jN47 zs42LfT906sw9_WZTye9dEjES@v~A&Zsqf!sWf}NbfDVoj&`!jgjKmKJ?!(q>)KhHOYd=Y^{zwLI?kh7pMc zrFo_;6H%KJyP3jXQmtnZ)OfQ-ljje+re!s>_5#Z%UQ*rYKhU$MDt7X>q15%z-gu0t z#QJj2K06Ey3F z%7IO&Id@V2H==H#`0e(vy&&D{?9j{Z!*1?lMB_8uOZcwlHT_S%>0*;sRTQ3S>9ZSE zyW0?IBmRjo=nu%Vt=bhW4x2aQl{&2!Co&z|M_HD2zm+S4LoXX%TcSUCPJm&@;gkdpPWm|etO^q{Fw zVl6>|K?(Q3Fi>LACk0xG+hA=4DJ|OJB8sv;(eb56w-M?q3wW1rA+HsSnwL>UYoQ=p zgzSMCz1gj+7V|!loYR~h+V8VRgcL&t$9V6f&4|>eGh; zJj;N@)ylHnw@e77Sz>-JzQS}|Gt{^7w_~MT(A9JBSs~3@*tLEd$JK2=s3KuQrRvp>$bxr zW7KvXQ3C-5&}_A<1iV2Ik;zKjzZTu>rBNIadgnWhkLM$`b#1MZH9cfZT=l}H8E@Po{cVQ|G3=vmbR3$rMdM9Q~<7yBbX ze8xmQ_82_+E`U#GV+nai0~W(-Vt^Jg8RIxQEbLTQ9A$h$WFoIRMs|j9tB<{#uW9i8 zvsg`Yu+SQxz&Aomd9~h8y;*phvi z@#X|or0}V-ZbP_2y9g`)arV-YB){fMDKwsaD_8iYN;=Vhyf{V5yjoH|Mt=G6Zc?XN zY{zzOb!q5Exq4Z%SfhbrhRLA+@!CscZy0tUa(bhJX_uLkcvVS)(+((E{hlFVMXQ4! z@uqaP*SO)faiNubt3|%gQRbjw5SGdBZ~->=d%f!H%^26?;m$vu-VstY`*w!*Ft-+{ zPWpqjH!ZuB?q9356C{Dv_a8{*I$()S$p=u$%z5Fo*4j53F(ZyJbr{q}JM=7j$!SWw z`*7GkA%;yHNWTyW1Vg){%>l6-slcV<~N|QW%qt%^}rLakx^q zPn53xXw=*Jy?b%>(QP%dz^M9qC#13%^ZONj^w)^r2u-Nu;pFBD#o3ElerqhhwHUIx z7A};WzcmxtGj1fq8s1ddeX1CXcsu$Z}4w3cp5W$9|C*u>u)qldtxOy6nhzO7|?wTc#ZqTFR!3YuJ0_sYmL z7#f{XR${Mr#}5naQh!bpsclbO=d$jWANKs9C$!XGXwuFkmF6i@QgkcI1N|0UE9XWs zjpl@47^9>>{dXsYFUfF}CZBqvj3s=T>Iz6MQ$k5hvMwbeb#}>*rrkK==D#qWl#~sn zT`T_K4!zNf90(2-u4oo^|Kul;IWhucbg&z*@#U;V*19nWAbI1RS8}fx)#y;;3g#^b z;CUR$V)3aM$fC&iVu1FzN!eyoN&8cxZly6#GgxK}lOU8hSTo9JHZ2zEQq2G}T zD2`LOT#F8&PL^ZH_M1=0b=NT4d8Bc5$1#O*q=y)6?V1&_rJ$4W4Pg`6B7u z6tj&p zFWR6)*2ZomRT;E4sXK_-VJ7TBL@p&)k+ns70{85DnGN`|&-Q9NsxC0iXPBBG*i0G# z2|{o6phF&EJjW%{^#gTlMungg#wU?XoxD%9BbCkPqDFSzj)n4ql*UYn$ddD;>(-t- zSA{4G(C=Hj?uTc#-eGGp6ElyDDZbPp%%@+LE_i(`;d;?S;O8>vsFi`gH$m1O=CdBA z?cOZ|+u|LI9<*qNm%AnX*-z*|3%HT&SyrrPo{RT^ z%pwwFN;|dGldt#PvUXD~DD0`ep6kPUU&s`P*|P}5KfXA)*o$&D9}r~K`<^QZo{b|U zbk%dwFBVlWN#Hn+T?5BU+;%_|wn1JW>w-Nd^s_r9Ty`#l;%$}$l%Fu^u~j0tf-#6; zMeXJ#MsvCiq=2a0S1v}i*NY7qz;Pw1vU~RZW*vVH)w@U-m3_NorKG4C^dXbAGh1f) z#EPS>0mlHSK9fIPJ+YwolV;8}cz(>o-4%+d+;oM~!!2l1BaDM9Kns ztJP+NI2*LFrh&Ky+2M6j@cf2T_!F`tma&q{H~BVsYC&V+y_{#@4rm|jFRER&5Yv;d zHtKyu;7*HX-*gp5vRk-!E!Gr%2X0OXz8@-H3bQOa+y^~mz2;)S&c2V_aKkxN4(=yx zKdoCwxK%Y?Sat;3j(_bc@e`vf^76#TT)ywt?)c&s)Y8&xpR=~0yW0BXcrNZ@P(z=3 zCcAfgClQp=%jx@ccAZ-QWgiiPyA*FujYz(X7vhMk!;-+3!|5~Ho6BWu8(|aK(|g%N zMv4-?qB5)caHyh43#3{vU)#W=EdpX8TqL(_gEnZ{dR(IUzmdhCWto!i1;qWb)MxIH|+K3$N zq_kNoQf#<97PQLpv=x-@W-V2$?KI@YyFoyRU35-0Q)`mUVF`ih|1ErCFEKDKoC{I@j ztj{^=r?nw7j{Y7qeA_Jo$u!a>%N*q<5?znR)xbypSQHVqhML5J$4_uZF~ZDl7Tg!K zTFQmVGEfa2bFwBf7$q$uBSXunI3NlL@HNXiCuL;u_vvcx>&chob&3l(d(({0o4e2`>`WjJJ+EWmt0Yy7RW{Kv}f zpTf-l_s@ldgoRhZ8RUb4mUD##8yXtw(R92t*BWjWxSte61pw3po*r$thSP4%Ha9mm zj(7w{6gsI|C;QUGzX&+nALAwqS4P|->4ZUkk&mSPMoFE%?Voe1jaL8wf%;{Zfu}GU zds%XI-J;a|YUh_G@DF7xm1p_rXgm8?{hc(uOSK{-*AY$&+@l8o@`*^R2M##7ndab& z Date: Thu, 5 Oct 2023 02:45:04 +0800 Subject: [PATCH 2/8] Formatted subheadings in bold --- docs/UserGuide.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index b94e7d935dc..e84e61bf1e1 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -177,19 +177,19 @@ Deletes a schedule in the address book based on their index number in the table ![delete schedule](images/deleteSchedule.png) -Format: `delete-s INDEX_NO` +**Format:** `delete-s INDEX_NO` -Example: +**Example:** * `delele-s 5` deletes the schedule that is indexed as 5 in the schedule list. * `list` followed by `delete-s 2` deletes the 2nd schedule in the schedule list. -Acceptable values for each parameter: +**Acceptable values for each parameter:** * `INDEX_NO`: NUMBER Only numerical input that ranges from 1 to the last schedule shown in the list of schedules -Expected output: +**Expected output:** * `Schedule has been deleted: Tutor: John Doe; Start date: Sep 15, 2023 09:00; End date: Sep 15, 2023 11:00;` -Error messages: +**Error messages:** * `Index number given is out of range`: Given index is out of range. * `Invalid value in parameter INDEX_NO`: Parameter given is not a numerical value. * `Missing parameter INDEX_NO`: A numerical value is not provided when calling the command `delete-s`. From 78e523dabb9dbe6af779321945b0d65c4558c8f3 Mon Sep 17 00:00:00 2001 From: Xuan Yi Date: Thu, 5 Oct 2023 02:53:08 +0800 Subject: [PATCH 3/8] Renamed parameter to SCHEDULE_INDEX for clarity --- docs/UserGuide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index e84e61bf1e1..34ab09e5776 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -177,14 +177,14 @@ Deletes a schedule in the address book based on their index number in the table ![delete schedule](images/deleteSchedule.png) -**Format:** `delete-s INDEX_NO` +**Format:** `delete-s SCHEDULE_INDEX` **Example:** * `delele-s 5` deletes the schedule that is indexed as 5 in the schedule list. * `list` followed by `delete-s 2` deletes the 2nd schedule in the schedule list. **Acceptable values for each parameter:** -* `INDEX_NO`: NUMBER Only numerical input that ranges from 1 to the last schedule shown in the list of schedules +* `SCHEDULE_INDEX`: NUMBER Only numerical input that ranges from 1 to the last schedule shown in the list of schedules. **Expected output:** * `Schedule has been deleted: Tutor: John Doe; Start date: Sep 15, 2023 09:00; End date: Sep 15, 2023 11:00;` From 0d896c738b111231ef68e78ab89b812b72662acf Mon Sep 17 00:00:00 2001 From: Shanny Date: Thu, 5 Oct 2023 14:01:30 +0800 Subject: [PATCH 4/8] Fixed parameter name to SCHEDULE_INDEX --- docs/UserGuide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 34ab09e5776..b6ccd2b2152 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -191,8 +191,8 @@ Deletes a schedule in the address book based on their index number in the table **Error messages:** * `Index number given is out of range`: Given index is out of range. -* `Invalid value in parameter INDEX_NO`: Parameter given is not a numerical value. -* `Missing parameter INDEX_NO`: A numerical value is not provided when calling the command `delete-s`. +* `Invalid value in parameter SCHEDULE_INDEX`: Parameter given is not a numerical value. +* `Missing parameter SCHEDULE_INDEX`: A numerical value is not provided when calling the command `delete-s`. _More details coming soon ..._ From 03f3f87c3b6c085a637726ffe74d79dfb5700108 Mon Sep 17 00:00:00 2001 From: Shanny Date: Thu, 5 Oct 2023 15:12:06 +0800 Subject: [PATCH 5/8] Removed trailing whitespaces --- README.md | 6 +++--- docs/DeveloperGuide.md | 18 +++++++++--------- docs/UserGuide.md | 6 +++--- 3 files changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 69c4c04f42d..e1833ec5e2f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Tutor Connect +# Tutor Connect [![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S1-CS2103T-T17-3/tp/actions) [![codecov](https://codecov.io/gh/AY2324S1-CS2103T-T17-3/tp/graph/badge.svg?token=CY67NSXKQZ)](https://codecov.io/gh/AY2324S1-CS2103T-T17-3/tp) @@ -31,7 +31,7 @@ To verify, perform the following steps: 3. Double click the jar file to launch the application. -> If you are a **Mac** user, you may encounter a warning that says the jar file cannot be opened because it is from an unidentified developer. +> If you are a **Mac** user, you may encounter a warning that says the jar file cannot be opened because it is from an unidentified developer. > To continue: > > i. **Right click** on the jar file and select `Open With > JavaLauncher (default)`. @@ -39,4 +39,4 @@ To verify, perform the following steps: > ii. Press **Open** when prompted. ## Acknowledgements -This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org). +This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org). diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 14db3800014..33520b485d7 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -352,7 +352,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli * 3a1. TutorConnect shows an error message. Use case resumes at step 2. - + * 3b. The schedule parameters is invalid. * 3b1. TutorConnect shows an error message. @@ -430,7 +430,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli * 3a1. TutorConnect shows an error message. Use case resumes at step 2. - + * 3b. The tutor information parameters is invalid. * 3b1. TutorConnect shows an error message. @@ -552,13 +552,13 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli 1. Should work on any _mainstream OS_ as long as it has Java `11` installed. 2. Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage. -3. A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse. -4. Should work without requiring an installer -5. _GUI_ should work well for standard screen resolutions 1920x1080 and higher, and, for screen scales 100% and 125%. -6. _GUI_ should be usable for resolutions 1280x720 and higher, and, for screen scales 150%. -7. Should not require the user to have an internet connection to use. +3. A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse. +4. Should work without requiring an installer +5. _GUI_ should work well for standard screen resolutions 1920x1080 and higher, and, for screen scales 100% and 125%. +6. _GUI_ should be usable for resolutions 1280x720 and higher, and, for screen scales 150%. +7. Should not require the user to have an internet connection to use. 8. Should be a single-user application. -9. Should persistently save data in a human-readable text file between sessions. +9. Should persistently save data in a human-readable text file between sessions. 10. Should be able to transfer the data file to another device with no loss of data. *{More to be added}* @@ -566,7 +566,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli ### Glossary * **Mainstream OS**: Windows, Linux, Unix, OS-X -* **Use case**: A description of a set of sequences of actions, including variants, that a system performs to yield an observable result of value to an actor +* **Use case**: A description of a set of sequences of actions, including variants, that a system performs to yield an observable result of value to an actor * **GUI**: Graphical user interface -------------------------------------------------------------------------------------------------------------------- diff --git a/docs/UserGuide.md b/docs/UserGuide.md index d5178ee5521..b9bdfa70f03 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -95,7 +95,7 @@ On top of these functionalities, we believe that tuition centre management must * Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.
e.g. if the command specifies `help 123`, it will be interpreted as `help`. -* If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple +* If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application. @@ -143,7 +143,7 @@ Displays a list of all tutors in the address book in a table format. * No acceptable values as list-t has no parameters **Expected Output**: -* Displays a table of tutors with columns for Name, Phone Number, and Email like +* Displays a table of tutors with columns for Name, Phone Number, and Email like the [image](#listing-all-tutors--list-t) above * If there are no tutors in the address book, displays a message telling the user to add a tutor with add-t: `There are no tutors in the address book. Please use /add-t to add a tutor.` @@ -167,7 +167,7 @@ Deletes a tutor in the address book based on their index number in the table. * `TUTOR_INDEX`: Only accepts numerical value **Expected output**: -* `Tutor has been deleted: Alex Yeoh; Phone: 87438807; +* `Tutor has been deleted: Alex Yeoh; Phone: 87438807; Email: alexyeoh@example.com; Address: Blk 30 Geylang Street 29, #06-40` **Error messages**: From e54234a429f1a9e912047ad8bf9ef7eaaff5a263 Mon Sep 17 00:00:00 2001 From: Shanny Date: Thu, 5 Oct 2023 15:15:06 +0800 Subject: [PATCH 6/8] Removed more trailing white spaces --- docs/DeveloperGuide.md | 2 +- docs/UserGuide.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 33520b485d7..660314d50dc 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -557,7 +557,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli 5. _GUI_ should work well for standard screen resolutions 1920x1080 and higher, and, for screen scales 100% and 125%. 6. _GUI_ should be usable for resolutions 1280x720 and higher, and, for screen scales 150%. 7. Should not require the user to have an internet connection to use. -8. Should be a single-user application. +8. Should be a single-user application. 9. Should persistently save data in a human-readable text file between sessions. 10. Should be able to transfer the data file to another device with no loss of data. diff --git a/docs/UserGuide.md b/docs/UserGuide.md index b9bdfa70f03..c8592cfc1bb 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -95,7 +95,7 @@ On top of these functionalities, we believe that tuition centre management must * Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.
e.g. if the command specifies `help 123`, it will be interpreted as `help`. -* If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple +* If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application. @@ -268,4 +268,4 @@ _More details coming soon ..._ | **Delete Schedule** | `delete-s INDEX_NO`
e.g., `delete-s 3` | | **Clear** | `clear` | | **Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`
e.g.,`edit 2 n/James Lee e/jameslee@example.com` | -| **Find** | `find KEYWORD [MORE_KEYWORDS]`
e.g., `find James Jake` | \ No newline at end of file +| **Find** | `find KEYWORD [MORE_KEYWORDS]`
e.g., `find James Jake` | From f75f0e092579cda2e73352c5468400e05fca28fe Mon Sep 17 00:00:00 2001 From: Shanny Date: Thu, 5 Oct 2023 17:15:01 +0800 Subject: [PATCH 7/8] Fixed toc and command summary --- docs/UserGuide.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index c8592cfc1bb..a25116cdfd2 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -15,7 +15,7 @@ Here’s an overview of what you can do with Tutor Connect: On top of these functionalities, we believe that tuition centre management must be efficient. Therefore, Tutor Connect is **optimised for users who can type fast** and utilise the Command Line Interface (CLI) to complete tasks using the keyboard faster than using the mouse. * Table of Contents - {:toc} +{:toc} -------------------------------------------------------------------------------------------------------------------- @@ -258,6 +258,7 @@ _More details coming soon ..._ -------------------------------------------------------------------------------------------------------------------- ## Command summary + | Action | Format, Examples | |---------------------|-----------------------------------------------------------------------------------------------------------------------------| | **Add Tutor** | `add-t n/NAME p/PHONE NUMBER e/EMAIL`
e.g., `add-t n/John Doe p/98765432 e/johnd@example.com` | From 8ddb29dcd74e572c7893fc72e2d1d4650a6a89c8 Mon Sep 17 00:00:00 2001 From: Xuan Yi Date: Thu, 5 Oct 2023 22:32:29 +0800 Subject: [PATCH 8/8] fixed typo --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index a25116cdfd2..9f7f7caec8d 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -226,7 +226,7 @@ Deletes a schedule in the address book based on their index number in the table **Format:** `delete-s SCHEDULE_INDEX` **Example:** -* `delele-s 5` deletes the schedule that is indexed as 5 in the schedule list. +* `delete-s 5` deletes the schedule that is indexed as 5 in the schedule list. * `list` followed by `delete-s 2` deletes the 2nd schedule in the schedule list. **Acceptable values for each parameter:**