[CS2113T-F12-4] CCAManager #48
Open
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
kengjit
reviewed
Oct 27, 2021
docs/DeveloperGuide.md
Outdated
Comment on lines
45
to
56
| ### **Note:** | ||
| * `makeMemberEntry()`: Creates a member in the memberList. | ||
| * `writeMemberFile()`: Writes the data to the csv file. | ||
|
|
||
| The *sequence diagram* below shows how various components of the architecture interact with one another when a user inputs a **valid** command `"delete /m 1"` | ||
|  | ||
|
|
||
| {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.} | ||
| ### **Note:** | ||
| * `getKeywordStatus()`: Gets the keyword value from the Keyword enum class. | ||
| * `deleteMember(members, entry)`: Deletes the member from the memberList. | ||
| * `deleteMemeber(memberNumber)`: Deletes the member using the index number provided by the user. | ||
| * `writeMemberFile()`: Writes the data to the csv file. |
There was a problem hiding this comment.
Perhaps it would be better to choose a better title than "Note"?
docs/DeveloperGuide.md
Outdated
|
|
||
| {Describe the value proposition: what problem does it solve?} | ||
| ###[Proposed] Storage component |
There was a problem hiding this comment.
You might want to add a whitespace between the ### and [Proposed] to prevent formatting problems
docs/DeveloperGuide.md
Outdated
Comment on lines
46
to
56
| * `makeMemberEntry()`: Creates a member in the memberList. | ||
| * `writeMemberFile()`: Writes the data to the csv file. | ||
|
|
||
| The *sequence diagram* below shows how various components of the architecture interact with one another when a user inputs a **valid** command `"delete /m 1"` | ||
|  | ||
|
|
||
| {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.} | ||
| ### **Note:** | ||
| * `getKeywordStatus()`: Gets the keyword value from the Keyword enum class. | ||
| * `deleteMember(members, entry)`: Deletes the member from the memberList. | ||
| * `deleteMemeber(memberNumber)`: Deletes the member using the index number provided by the user. | ||
| * `writeMemberFile()`: Writes the data to the csv file. |
There was a problem hiding this comment.
Could perhaps split these methods into different components? (i.e. Member, MemberStorage...)
|
|
||
| The *sequence diagram* below shows how various components of the architecture interact with one another when a user inputs a **valid** command `"add /m Bob /s A01231234B /p 98765432"` | ||
|
|
||
|  |
There was a problem hiding this comment.
Perhaps you could standardize what you want User to be.
| * [Getting Started](#getting-started) | ||
| * [Design](#design) | ||
| * [Architecture](#architecture) | ||
| * [Appendix: Requirements](#appendix-requirements) |
There was a problem hiding this comment.
Should there be a link to the Manual Testing section for consistency?
|
|
||
| The *sequence diagram* below shows how various components of the architecture interact with one another when a user inputs a **valid** command `"add /m Bob /s A01231234B /p 98765432"` | ||
|
|
||
|  |
There was a problem hiding this comment.
Should there be an 'X' to denote the end of the lifeline of an object to show its deletion? If PUML doesn't allow it, maybe note could be written at the start to explain this behaviour.
docs/DeveloperGuide.md
Outdated
|
|
||
| {Describe the value proposition: what problem does it solve?} | ||
| ###[Proposed] Storage component |
There was a problem hiding this comment.
Perhaps your group missed out a space here, as the heading formatting is not showing up
Suggested change
| ###[Proposed] Storage component | |
| ### [Proposed] Storage component |
docs/DeveloperGuide.md
Outdated
Comment on lines
84
to
89
| *can save attendance data in CSV format and read them back into the `AttendanceList` object. | ||
| *automatically deletes to AttendanceStorage.csv whenever a member is deleted from the `AttendanceList` object. | ||
|
|
||
| The `training schedule` component | ||
| *can save trainings schedules and read them back into the `TrainingList` object. | ||
| *automatically deletes in the file whenever a training schedule is deleted from the `TrainingList` object |
There was a problem hiding this comment.
Perhaps you are missing out on a space between the starting character and the star (*) to show the lines as a list
Suggested change
| *can save attendance data in CSV format and read them back into the `AttendanceList` object. | |
| *automatically deletes to AttendanceStorage.csv whenever a member is deleted from the `AttendanceList` object. | |
| The `training schedule` component | |
| *can save trainings schedules and read them back into the `TrainingList` object. | |
| *automatically deletes in the file whenever a training schedule is deleted from the `TrainingList` object | |
| * can save attendance data in CSV format and read them back into the `AttendanceList` object. | |
| * automatically deletes to AttendanceStorage.csv whenever a member is deleted from the `AttendanceList` object. | |
| The `training schedule` component | |
| * can save trainings schedules and read them back into the `TrainingList` object. | |
| * automatically deletes in the file whenever a training schedule is deleted from the `TrainingList` object |
Add delete by name for member
fix coding style
Fix Gradle
Izdiyad v2.0
Change information regarding delete member command and expected output for member commands
Teck hwee v2.0
Add find training function, add Index to TrainingSchedule
Fix edit member issue
Teckhwee v2.0
v2.1 Update DG diagrams
change PPP for ian
change PPP for ian
Edit Image
v2.1 Glenn Update DG and PPP
fix minor bug in parser
v2.1 Update PPP
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.
This product is designed for the NUS CCA manager who has a lot of administrative tasks to keep track of. The interface uses CLI instead of GUI to fit the preferences of the CCA manager.