search

nus-cs2103-AY2122S1 / pe-dev-response

0 stars 0 forks source link

Addgroup command in UG doesn't match examples #5841

Open nus-se-bot opened 2 years ago

nus-se-bot commented 2 years ago

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

Given format in UG:
addgroup -g <group_name> [(-n <student_name> | -i <student_id>)]...

Implies you can only add either the student name or the nusnet id.

Actual examples:
addgroup -g T01A -n Hong Yao -i E0123456

Inputting both the student name and id.

[original: nus-cs2103-AY2122S1/pe-interim#5809] [original labels: severity.Medium type.DocumentationBug]

ganhongyao commented 2 years ago

Team's Response

Implies you can only add either the student name or the nusnet id.

The interpretation of this is correct, because the user should only specify the student's name OR nusnet ID.

However, there is nothing wrong with the example given (addgroup -g T01A -n Hong Yao -i E0123456) because the command format specifies image.png

The ... means that the argument can be specified more than once, as seen in the Notes section:

image.png

It is likely that the tester misunderstood the meaning of the example given, thinking that Hong Yao and E0123456 refer to the same student, but in fact they are different students.

Duplicate status (if any):

--