riccqi / pe

1 stars 0 forks source link

Undo/redo feature of addressbook found in DG, not adapted to Salesy's context #13

Open riccqi opened 1 year ago

riccqi commented 1 year ago

The section for proposed implementation for undo and redo is still found in the DG, even though the content of the section is writing about how to implement it for the AddressBook app.

There doesn't seem to be any attempt at converting this to be relevant to the Salesy app. The mention of the AddressBook app here will definitely confuse future devs.

Screenshot 2022-11-11 at 5.23.56 PM.png

nus-pe-script commented 1 year ago

Team's Response

Should have been removed

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: While I understand from the team that this is a honest mistake and could have been fixed just by deleting the whole section, I still remain that from a reader perspective, having this entire section that is unrelated to the app will be very jarring and deserves a medium severity.

As a new developer reading this DG and coming across this proposed feature that has a half baked implementation that seems to be talking about another app. I can imagine it being highly disorienting.