search

Alteqa / pe

0 stars 0 forks source link

Explanation for add command in DG not present #18

Open Alteqa opened 2 months ago

Alteqa commented 2 months ago

No explanation of add commands in DG: image.png

nus-pe-script commented 2 months ago

Team's Response

The explanation for the add command is similar to that of the delete command since they interact with the same classes and objects in the program. To make the DG less repetitive, we opted to leave it out. We should have mentioned the reason why we left it out in the DG, however.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: The add command is definitely in the scope of your documentation as it is a major feature of your app. As such, choosing not in scope is not appropriate as this is a issue that should be rectified. Especially for such a major command as add, the work to include some information on it is more important than delete itself. Thus, this is a significant documentation bug.

## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]