search

nus-cs2103-AY2324S1 / pe-dev-response

0 stars 0 forks source link

Use cases not detailed enough #5985

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.

Some use cases in DG are not specified enough, espescially for all users input wrongly is a too general extenstion, since there could be multiple sub situation happen as index are invalid, musician doesn't exist in the band or other situations. image.png

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

yytan25 commented 1 year ago

Team's Response

Thank you for the comment. However, we feel that exhaustively listing out every possible error cases in the DG might be an overkill, as suggested here:

image.png

We feel that the error cases are more meaningful to the users, which is why for all musician and band features, we try to exhaustively list out every possible error cases in our UG:

image.png

However, as the target audience for DG is primarily the developers and a valid assumption is that they will go through UG and the source code, we think that it is reasonable for us to not include every detail of error handling in the DG.

Duplicate status (if any):

--