chiaryan / pe

0 stars 0 forks source link

Editing last modification time can cause incorrect reporting of outdated room number #4

Open chiaryan opened 3 months ago

chiaryan commented 3 months ago

Steps to recreate:

  1. close application
  2. edit the date given after the dorm room number (assumed to be the last modification date) to an earlier date.
  3. upon reopening the app the app incorrectly reports as an outdated rm number.

I'd classify this as a bug since this bahviour is not documented in UG.

nus-se-bot commented 3 months ago

Team's Response

I would say that it's more of a documentation bug than anything, as this is intended functionality. Imagine you got the roomNumber from an earlier date however forgot to input it until now: You might still want the system to register it as being last updated when you first got the room number.

image.png The message above however, is shown in the UG. I feel that editing json files is not something we expect our regular users to do, as such we did not include it in the user guide. Users who do update the json file directly should also have a copy of their previous version should they want to revert the changes. As for the developers, we include instructions on how to change the json file and explicitly state what it does.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: [replace this with your explanation]


## :question: Issue type Team chose [`type.DocumentationBug`] Originally [`type.FunctionalityBug`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]