search

nus-cs2103-AY2324S1 / pe-dev-response

0 stars 0 forks source link

No mention of certain features' limitations after using find in the UG #5972

Open nus-se-script opened 1 year ago

nus-se-script commented 1 year 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.

Under the find feature in the UG, it would be helpful to include that the list command needs to be used before trying to edit contacts outside of the result given by find. Otherwise, it just shows that the index is not found.

image.png

I think it's fine that editting only works for contacts in the customer list, since some commands mention that " should only be one of the indices shown in the displayed list" but it would be helpful to mention it in the find section of UG as well, as the commands like insurance, addappt etc. are all affected by this.

[original: nus-cs2103-AY2324S1/pe-interim#5942] [original labels: severity.Low type.DocumentationBug]

yucongkoo commented 1 year ago

Team's Response

Hi there, thanks for bringing up this issue.

From our understanding, what you meant here is that, as our find command will reduce the displayed list to a certain subset of customers, the user would then not be able to use edit(or any other commands that work on indices) on customers not in the list.

We have structured our response as follows:

Under the find feature in the UG, it would be helpful to include that the list command needs to be used before trying to edit contacts outside of the result given by find.

We do not quite agree with this, as we think that the find feature is not necessarily followed up by the edit command(or any other commands that work on indices), the find command itself is used to find customers with certain attributes. Hence, we think that mentioning of follow up actions is not really appropriate to be put under find command, they are separate actions to be performed by users.

Rather, we think that the restriction of the indices that could be used should be mentioned under the command that requires the indices itself, which is what we did in our UG, as mentioned by you too as follows, where the some other commands you mentioned is all commands that work on indices.

since some commands mention that " should only be one of the indices shown in the displayed list"

As a conclusion, the main reason we are rejecting this bug is that the find and edit (or any other commands that work on indices) are two separate features, and the indices restrictions is bonded to the edit command (or any other commands that work on indices), not the find command, hence it should not be mentioned in the find section.

Duplicate status (if any):

--