search

redders7 / pe

0 stars 0 forks source link

Unnecessarily detailed explanation for commands #9

Open redders7 opened 2 years ago

redders7 commented 2 years ago

image.png

Edit command can start from the execute call. Explanation of parser and main methods are repetitive and unnecessary.

nus-se-bot commented 2 years ago

Team's Response

Once again, Documentation Bugs are to be set as Very Low. While the intention was for the Developer to understand the entire flow of the Command, we understand that an over-arching idea would have been sufficient. We will accept this at the lowest severity.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: Initially reported as severity.Medium, but upon consideration this should be severity.Low. According to the CS2113 guidelines, only cosmetic issues should have severity.veryLow. This issue affects the reader's ability to understand the command's implementation due to its overcomplexity.