soc-se-bot
commented
10 months ago Team's Response
We accept the missing parameter, but we do not think it should receive medium because it appears only twice in the documentation and we explain below the sequence diagram how the Logic Component interacts with model when running execute command
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
Missing argument in execute function in sequence diagram under Logic Component section
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.
The execute() in the sequence diagram is wrong as it is missing the argument of model as the function's parameters. This is not in line with the actual implementation of the execute function in the LogicManager class.
[original: nus-cs2103-AY2324S1/pe-interim#1771] [original labels: severity.Low type.DocumentationBug]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
No details provided by team.
Items for the Tester to Verify
:question: Issue duplicate status
Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]
In the below pic, the method call execute() should have a parameter, e.g., model. As this error appears two times in DG, I will give a severity.Medium instead of severity.Low, as this bug appears in multiple locations and it is NOT a purely cosmetic issue - fellow developers will misunderstand the design of the application.
The section of the code from your most recent release is appended below to show that it indeed takes in a model parameter