nus-pe-bot
commented
1 year ago Team's Response
We thank you for the astute observation, and for the provided suggestion. However, the COMMAND_SUCCESS should not be taken at face value.
Even if you tried to match the variables to what is actually being utilized within our code, we simply meant to communicate the fact that the current scenario being displayed is a successful one compared to our other variables, MESSAGE_TASK_FOUND_S,MESSAGE_TASK_FOUND_P, and MESSAGE_NO_TASK_FOUND, COMMAND_SUCCESS is way more concise, encapsulating the meaning of a successful return message, and captures the brevity that is expected of UML models. To add multiple verbose variable names would not be realistic of an ideal UML. Thus, this would not hinder the comprehension of DG at all.
Given that the spirit of UML is meant to be as concise as possible, we also chose to show this scenario as we would not want to show the developers how a wrong scenario plays out within the UML.
Items for the Tester to Verify
:question: Issue response
Team chose [response.NotInScope]
- [x] I disagree
Reason for disagreement: Agree with you that UML is to be as concise and it makes the most sense to show how a correct/expected scenario plays.
However, I think my last line of the bug report may still stand? i.e. "I think maybe to illustrate a successful command call, the team could provide an example, i.e. execute("findt slides"), instead of using execute(commandText)." By doing so, this will help you to "communicate the fact that the current scenario being displayed is a successful one" (quoted from your reply).
Also, sequence diagrams model the interactions between various entities in a system, in a specific scenario, hence, I think it is necessary to provide the example.
The sequence diagram states that it would return CommandResult(MESSAGE_SUCESS). However, not this command may not always result in success. (i.e., could have no tasks found).
Furthermore, in your code, there is no MESSAGE_SUCESS constant. There is only MESSAGE_TASK_FOUND_S, MESSAGE_TASK_FOUND_P, and MESSAGE_NO_TASK_FOUND.
Similar error may be identified for other sequence diagrams, such as the AddTask sequence diagram which could also result in the MESSAGE_DUPLICATE_TASK instead.
I think maybe to illustrate a successful command call, the team could provide an example, i.e. execute("findt slides"), instead of using execute(commandText).