search

zhou-colla / pe

0 stars 0 forks source link

Use Case 3 Documentation Bug #5

Open zhou-colla opened 1 week ago

zhou-colla commented 1 week ago

Description In Use Case 03, it is mentioned in extensions 1a that the Program resumes from step 2 at the end.

Steps to identify

  1. Go to the DG Use Case 3

Program There seems to be a mismatch in which the use cases are supposed to terminate there, and if the user correct the mistake, there will start from step one again by entering a new command which counts as a new attempt.

Screenshot image.png

nus-pe-script commented 1 week ago

Team's Response

Thank you for raising this issue. However, if you actually run the application, you will see that it will resume from step 2 and not 1. Moreover, if you resume from step 1, there would be a double logging of the reminder which is inaccurate in our case.


video:https://raw.githubusercontent.com/nus-cs2103-AY2425S1/pe/master/files/af6340f9-e3b4-4ce8-b55b-85183a372179.mp4

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Thank you for your response. I appreciate the clarification that the application resumes from step 2 in practice. However, I believe the explanation does not fully address the concerns raised about the documented use case. Let me elaborate:

The use case documentation suggests that only if the user enters invalid Name input (as per extension 1a), the program will resume from step 2 after the error is corrected. However, what if the user enter another valid command? Does the user get stuck in the loop forever? It seems not, what the error validation extension do is basically showing the error message and nothing else.

## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** VeryLow is only for cosmetic issues. I believe its impact goes beyond that of a purely cosmetic problem as it will cause confusion on the implementation. The documentation is a critical resource for developers, especially for new contributors. Ambiguity or inaccuracies in the use case can mislead them, resulting in incorrect assumptions about the program's behavior or logic. The user may misinterpret that there are new looping mechanisms validating user inputs under each function, but that's not the cases.