search

neojxuan / pe

0 stars 0 forks source link

More details can be given about command history implementation #15

Open neojxuan opened 2 years ago

neojxuan commented 2 years ago

For example, what happens if the user has reached the last command and presses the 'down' key? Or if the user has reached the first command? How does the program handle this? I think this can be briefly mentioned in either the activity diagram or the description of the feature.

image.png

nus-pe-bot commented 2 years ago

Team's Response

Thank you for the response :) While this is not specifically mentioned in the command history activity diagram, those behaviours are mentioned on the manual testing part. Also, the CS2103T website mentions omitting details from a diagram is OK if it does not mislead/hinder the reader. The activity diagram and the section do not mislead or hinder the reader from understanding the history feature.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I feel the main issue is the lack of details given (as mentioned in the title of the report). This makes it so that there is nothing additional a developer can gain from reading the entire description and diagram in the developer guide. They will still have no clue how the feature is implemented and they will only have about as much knowledge about the feature as any user who isn't a developer. Hence, since this section (Implementation > Command History feature) is included, there should be more details given, whether in the description, the activity diagram, or even a different type of UML diagram might be more appropriate (e.g. sequence diagram/class diagram). I have attached a screenshot of the entire section on the Command History feature, which shows how little detail is given.

In fact, I believe the Command History feature is slightly different from the other features that parse user input (it listens for additional key presses instead) and it is probably more related to the UI parts rather than Logic/Parser components like for the other features. New developers would probably not be able to tell how the feature is implemented from the description of its implementation in the DG.

image.png