From 31223a6a9079831c8e937a21849f2fe2176f0a26 Mon Sep 17 00:00:00 2001 From: xinen <117985016+xinen26@users.noreply.github.com> Date: Thu, 4 Apr 2024 19:36:50 +0800 Subject: [PATCH] Update DeveloperGuide.md --- docs/DeveloperGuide.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index c6db3f79bdb..9e46a4bd15d 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -187,9 +187,10 @@ assumed to be at the `'Initial Application'` stage. The `edit` command gives users the ability to edit the applicants' details. The details that can be edited include `Name`, `Phone`, `Email`, `Address`, `Stage`, `Role`, `Note` and `Tag`. Note that at least one field has to be chosen. #### How the feature is implemented -* The `edit` is implemented using the `EditApplicantCommand`, `EditApplicantDescriptor` and `EditApplicantCommandParser` classes +* The `edit` is implemented using the `EditApplicantCommand`, `EditApplicantDescriptor` and `EditApplicantCommandParser` classes. * The `edit` receives an index of the applicant to be edited and an EditApplicantDescriptor class which consists of the updated fields of the applicant. -* Note that the checks will be done on the fields that the user want to input to ensure is valid. For example, `Stage` can only be one of the four forms `Initial Application`, `Technical Assessment`, `Interview`, `Decision & Offer`. Hence, if user was to input `edit 1 /stage WaitListed`, this will not be possible and the applicant will not be edited. +* Note that checks will be done on the fields that the user want to input to ensure is valid. For example, `Stage` can only be one of the four forms `Initial Application`, `Technical Assessment`, `Interview`, `Decision & Offer`. Hence, if user was to input `edit 1 /stage WaitListed`, this will not be possible and the applicant will not be edited. +* Similarly, a check will be done to ensure that the index is valid. ![EditSequenceDiagram](images/EditSequenceDiagram.png)