search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Missing extension when user wants to delete the command #5534

Open nus-pe-bot opened 1 month ago

nus-pe-bot commented 1 month 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.

I think there is missing part in all extensions, where the user decides to not proceed after entering the command halfway.

Extension x.x ...user deletes the command using backspace...

would help a lot.

image.png

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

aureliony commented 1 month ago

Team's Response

Thank you for the bug report. It is difficult to cover every single extension (e.g., user deletes the command, user closes the application, etc.), and doing so may make the DG harder to read. This is a missing detail that does not hinder the developer's understanding of the use case. Furthermore, "deleting the command using backspace" is an implementation/UI detail that should not be included in use cases, as specified in the textbook:

image.png

Additionally, as mentioned by prof in this forum post:

it is fine to omit extensions that do not add value

Duplicate status (if any):

--