search

KinTatHo / pe

0 stars 0 forks source link

Mark loan causes the loan to disappear #1

Open KinTatHo opened 2 months ago

KinTatHo commented 2 months ago

Information

When I mark any loan of any individual, causes the loan to disappear

Steps to reproduce

  1. Link any loan to the user
  2. viewloan of that user's index
  3. mark that specific loan of the user

    Expected

The status of the loan will be updated accordingly and will be reflected in the loan list

Actual

The loan disappears

Screenshot 2024-04-19 at 4.29.16 PM.pngScreenshot 2024-04-19 at 4.29.16 PM

Screenshot 2024-04-19 at 4.29.19 PM.pngScreenshot 2024-04-19 at 4.29.19 PM

soc-se-bot commented 2 months ago

[IMPORTANT!: Please do not edit or reply to this comment using the GitHub UI. You can respond to it using CATcher during the next phase of the PE]

Team's Response

Thank you for pointing this out. However, we believe this is a misunderstanding caused by a documentation bug instead of a functionality bug. In our UG, we stated that the "status of the loan will be updated accordingly and will be reflected in the loan list" (screenshot 1). Our intention behind this statement was that the status of the loan will be updated (internally) from isReturned = false to isReturned = true. This would correspondingly update the status of the GUI loan from Returned: No to Returned : Yes (see screen recording). This was what we meant by the status being "reflected in the loan list". Screen Recording
video:https://raw.githubusercontent.com/nus-cs2103-AY2324S2/pe/master/files/c54eecfa-742d-4ced-a93d-73bc8deec9c5.mov The functionality is in fact working as expected as we stated that within viewloan, if the -a flag is not provided, only the active loans (see screenshot 2), i.e. the ones that have Returned: No, will be shown. This is why the loan "disappears", as the user is currently on the "view all active loans" page which dynamically updates when the loan is marked as returned (i.e. inactive). As such, once the status update has occurred due to markloan, the loan is not shown under viewloan, which shows only active loans in the loan list. Rather, it is shown under viewloan -a which shows all active and inactive loans in the loan list, as the marked loan is now no longer an active loan, as stated in the UG.

image.png

(Side note: if you want to view all active and inactive loans of only 1 person, as in the example you gave, you can navigate to the full person list using list and then run viewloan -a INDEX, where INDEX is the index of the person in the person list. This is given in the UG too.) Therefore, this is not a functionality bug and the app is working exactly as intended. Furthermore, the severity of the bug is not high as the software provides a perfectly viable way for the user to review the loans that they have just marked. As such, the usage is not affected and the product is perfectly usable. We relabeled the severity to low and change the bug type to a documentation bug as we admit that it is possible that our phrasing was slightly unclear (resulting in minor inconveniences), thus causing users to misunderstand that the marked loans will be shown within the same list immediately after the command. However, this is unlikely to affect normal operations as we provided clear instructions on how to view inactive loans, i.e. loans that have been marked (see screenshot 2).

Screenshot 1 Screenshot 2024-04-21 at 1.33.59 AM.png Screenshot 2 Screenshot 2024-04-21 at 1.42.14 AM.png

Items for the Tester to Verify

:question: Issue type

Team chose [type.DocumentationBug] Originally [type.FunctionalityBug]

Reason for disagreement: [replace this with your reason]

## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.High`] - [ ] I disagree **Reason for disagreement:** [replace this with your reason]