soc-se-bot
commented
2 years ago Team's Response
No details provided by team.
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
UG add command does not have a good example
Details
As per the UG in the image above, when I copy paste the command into the application, the command has an invalid formatting (shown in screenshot #1). After fixing the command, the values in the example given says that there is already an duplicate candidate. Since the candidate in the list does not show their email or phone number, it is hard for me to know what kind of phone numbers or email already exists. This makes it hard to know whether what fields have already been use for testing. It is also extremely tedious to use the 'focus' command to note what kind of information is already inside without deleting all the information that is present.
Screenshot
1
2
[original: nus-cs2103-AY2122S2/pe-interim#3275] [original labels: severity.Low type.DocumentationBug]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
The example provided in the add command section was solely used for an example of what a valid add command would look like and what would be the expected result. The system behaviour works correctly by verifying that the candidate already exists. In the event the user is adding an actual candidate, the candidate would be uniquely identified by his/her student id/nus email/phone, which eliminates the issue of the tester not being able to figure out the duplicate. A simple find would also enable the tester to easily figure out which field is duplicated in the system. Hence we believe that this report should be rejected.
With reference to the first provided screenshot (#1), under the PE guidelines, the prof has also mentioned that it is important to verify copied text from PDF. The invalid input is a result of the tester copying from the pdf directly without checks on the spacing that might be affected by copying which is hence not considered a bug and is thus rejected.
Items for the Tester to Verify
:question: Issue duplicate status
Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
:question: Issue response
Team chose [response.Rejected]
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
:question: Issue type
Team chose [type.DocumentationBug]
Originally [type.FeatureFlaw]
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
from the add command example given, simply copying and pasting the example command into the input for the programme gives the following error:
As a CS student i was able to realise the problem with the following command,
add id/A0123456B n/John Doe p/87654321 e/E0123456@u.nus.edu c/Computer Scienceyr/2 avail/1,2,3with there being no spacing between
Computer Scienceyr/2...flags, and managed to rectify it, but i believe the average user would have trouble identifying this bug that there is a spacing issue between the flags which is giving rise to this error, so this may not work accordingly with common users.