Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

execute command does not have model parameter #12

Open
Darren159 opened this issue Nov 17, 2023 · 1 comment
Open

execute command does not have model parameter #12

Darren159 opened this issue Nov 17, 2023 · 1 comment

Comments

@Darren159
Copy link
Owner

Darren159 commented Nov 17, 2023

In the sequence diagram for the undo command the execute command does not have model as a parameter which is incorrect as seen in the code.

image.png

image.png

@nus-se-script
Copy link

nus-se-script commented Nov 20, 2023

Team's Response

There is no convention saying that what we put there must exactly match the method that we call. In this case it is, but it is not necessary to indicate that model was an argument, because we feel that there is no ambiguity as there is only one execute method in the UndoCommand class. We think that there is no relevant information lost by not including it as an argument in the diagram.

Items for the Tester to Verify

❓ Issue response

Team chose [response.Rejected]

  • I disagree

Reason for disagreement: While true that there is no convention saying that what you put there must exactly match the method, the other methods in the same diagram that require parameters do include the parameters and methods like undo() which do not require a parameter include an empty ().

image.png

Furthermore, other commands within the same DG include the model for the execute command which might lead readers to believe that for the undo command, the execute command does not require a parameter.

In addition, even if there is no relevant information lost like the team says, it is still considered wrong/an error and hence a bug. Even if it might not have a large impact, it should still be corrected and hence I feel should not be Rejected.


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants