Skip to content

Commit

Permalink
Merge pull request #320 from Andrew22Teoh/UpdateDocs
Browse files Browse the repository at this point in the history
Fix formatting issue
  • Loading branch information
rayray39 authored Nov 12, 2024
2 parents 6a6f904 + 425cd43 commit aaa13dd
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -617,7 +617,7 @@ For reference, our group has 5 members.
1. Make `list` command with miscellaneous parameters error message more helpful. Currently, typing `list` with miscellaneous parameters, ex. `list 123`, will result in a message that states "Please ensure your command is valid!". To improve specificity this will be changed to ask user to remove miscellaneous parameters.
2. Prevent tags from allowing underscores. When searching for tags with underscores in the find command, the underscores are interpreted as an `or`. This means that searching for the tag "low_income" will bring up all tags containing "low" and "income" instead of just "low_income".
3. Remove `remark` command while keeping remark fields. Currently, remarks can be added via the edit command or the remark command but not the add command. Instead of having a dedicated `remark` command, we will allow users to use the `add` command to create a contact with remarks, or the `edit` command to modify the remark of a contact. This change solves an associated issue whereby the remark command currently collapses the detailed view on the contact.
4. Restrict the validation regex for emails to require at least 2 domain labels in the domainName region of the email. Traditionally, emails require at least 2 domain labels separated by a ., but the current implementation only requires one domain label. Something like johnsmith@yahoo is accepted as an email address when it should be rejected.
4. Restrict the validation regex for emails to require at least 2 domain labels in the `domainName` region of the email. Traditionally, emails require at least 2 domain labels separated by a `.`, but the current implementation only requires one domain label. Something like `johnsmith@yahoo` is accepted as an email address when it should be rejected.
5. Update the error message displayed to the user by the `edit` command upon attempt to index with 0. The current error message for `edit 0 n/Bob` states "invalid command format" when it should mention that the index provided is invalid.
6. Update the error message displayed to the user by the `remark` command upon attempt to index with 0. The current error message for `remark 0 r/Hates frisbees` states "invalid command format" when it should mention that the index provided is invalid.
7. Update the error message displayed to the user by the `delete` command upon attempt to index with 0. The current error message for `delete 0` states "invalid command format" when it should mention that the index provided is invalid.
Expand Down

0 comments on commit aaa13dd

Please sign in to comment.