search

chewterence / pe

0 stars 0 forks source link

DG Inconsistent task command naming convention in activity diagrams #13

Open chewterence opened 3 years ago

chewterence commented 3 years ago

Refer to the first rounded box for each of the diagrams. some task commands are spelt out in full sentences, while others are not.

Example: "deleteTask command" vs "mark task as completed command"

image.png

image.png

image.png

nus-pe-bot commented 3 years ago

Team's Response

No fix formatting to the details inside the activity diagram boxes is required. As long as the steps are understood, this is not an issue

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Thank you for the response.

While i agree that "As long as the steps are understood, this is not an issue", but i believe that there is room for misinterpretation here.

deleteTask Command could be referred to the class, but since it is in camel case it could also be referring to an object. If the actual intention is meant to be interpreted as the "delete task command", then it should be formatted as so. Hence, causing a slight confusion when I was reading it, and is possible that a potential developer reading this developer guide could also be confused.

Therefore, I strongly believe that this bug should be accepted.

:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.Low]

Reason for disagreement: As explained above, this is a flaw that causes occasional confusion to developers reading the developer guide due to the inconsistent formatting.