Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add command in the UG #108

Open
nus-pe-bot opened this issue Apr 20, 2021 · 2 comments
Open

add command in the UG #108

nus-pe-bot opened this issue Apr 20, 2021 · 2 comments

Comments

@nus-pe-bot
Copy link

[destination: nus-tic4002-AY2021S2/pe-moderation assignee: boydanderson labels: response.Rejected severity.Low team.3 tutorial.TIC4002-F18 type.DocumentationBug duplicate pending.0]

Summary of items to check:

Nothing to check :-)



Issue Description

First, in the example, the last bullet point is not consistent with the first two.

Second, the add does not mention clearly the g/[GROUP] command when add a new person.

The app allows multiple g/ when add a new person, but only takes the first g/ and ignore the rest g/. e.g the first group name is not existed, it will take the second group name if the second one is a valid group name.

Such restriction should be mentioned clearly in the UG for user to follow the command rather than let the user to trial and error the command.

Screenshot 2021-04-16 at 7.48.09 PM.png


[original: Yiheng0410/pe#3]

Team's Response

The duplicated bullet point is accepted, but the second point has been explained in the following section in the UG:

image.png

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Information not enough about add command in the UG.

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.



1, dose not mention what fields are compulsory/optional.
2, dose not mention the order of each filed is not fixed.
3, dose not explain the g/GROUP command clearly. e.g. if multiple groups is allowed? what happens if user enter mutile g/GROUP commands.


[original: nus-tic4002-AY2021S2/pe-interim#17] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

The add command format has been following the "Notes about the command format" as shown below:

image.png

image.png

To Check [0 Items]

Nothing to check :-)

@soc-se-bot-blue
Copy link

The formatting seems to be correct

@soc-se-bot-blue
Copy link

Stale issue. Close?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants