whatthelump / pe

0 stars 0 forks source link

Stats command does not reflect unattempted flashcards #1

Open whatthelump opened 3 years ago

whatthelump commented 3 years ago

Expected behaviour: stats without index parameter should show overall statistics for all flashcards in current list. If there are unreviewed flashcards, an error message similar to the following should appear:

FlashbackYouHaveNotReviewed.png

Actual behaviour: stats without index parameter shows statistics for attempted flashcards in current list.

Steps to reproduce:

  1. Filter the list such that it shows less than the full list of flashcards.
  2. Do a review and answer for all the flashcards in the filtered list.
  3. After finishing the review, enter 'list' command to show full list of flashcards.
  4. Enter stats command without index parameter to show overall statistics for all flashcards in the current list.

FlashbackStats.png

nus-pe-bot commented 3 years ago

Team's Response

It is not mentioned in the UG/DG that if there exists flashcard(s) that are not reviewed, then the error message: "You have not reviewed the card(s) yet" should be displayed. Such error message will only be displayed if none of the flash cards in the list has been reviewed.

However, it is mentioned in the UG that stats would show the overall review count, correct count, and the corresponding correct/wrong rate of the flash cards in the flash card list displayed.

For the example that you provided, it is expected behavior of the application, since the unreviewed flash cards would have review counts and correct counts of 0.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: The correct count, review count, and the correct rate are indeed accurate. However, I do think it is reasonable for a user to expect the statistics to reflect unreviewed cards as well. Perhaps this is more of an enhancement than a bug, but having a separate counter for unattempted flashcards could be added, especially since there is already a functionality to display an error message when all the flashcards in the list are unattempted? My main issue with this 'bug' is that looking at the 2nd image, the statistics graphic would be misleading for users, and even if they did check the numbers below, they would not know which of the flashcards in the list have been reviewed.