dillontkh / pe

0 stars 0 forks source link

Unclear explanation of pros in alternative provided #21

Open dillontkh opened 2 months ago

dillontkh commented 2 months ago

image.png

In what situation would editID be a clearer syntax? Since you are editing the event and not the ID

nus-pe-script commented 2 months ago

Team's Response

Thanks for pointing it out! At the start, the original name for the Edit Event feature is called Edit Important Date. However, this design consideration was not updated.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: image.png

I disagree that it should be downgraded to VeryLow.

My understanding of this "Design Considerations" section is that it is for future developers who are trying to understand some of the design decisions. If it does not clearly explain why the current implementation was ultimately chosen over the alternatives, I think it's fair to say that it becomes less useful for developers reading it.

After further clarification from the team, who explained that editID was short for edit Important Date (an outdated feature name), I struggle to see the value this section provides even more.

Hypothetically, if they did catch this to update it, and change editID to edite, then there would be no more alternatives to consider. (in which case, maybe a Low severity could be considered generous)

I believe the reasons outlined above allow this bug to qualify for more than just a purely "cosmetic problem", which is what the VeryLow severity indicates.