Hws2209 / pe

0 stars 0 forks source link

"headlines" command don't fit well with some other commands #3

Open Hws2209 opened 6 months ago

Hws2209 commented 6 months ago

Since the headlines command uses the main list of articles, perhaps it would be better to only allow it after "back" (if user have used "filter" or "suggest" before that). Otherwise, it is slightly confusing. For example, in the picture, "url 5" gives the url of the 5th article under Technology

image.png

soc-se-bot commented 6 months ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Inconsistent Article Indexes between different commands when filtering through topics

When filtering through the articles via a specific topics, e.g. "filter politics". The Index numbers used for commands such as "headlines" and "extract" are inconsistent. Some commands index are based on the "main list", while others are based on the "filtered list". Here's an example:

____________________________________________________________

What do you want from me?
____________________________________________________________

filter politics
____________________________________________________________

Here are the news articles related to Politics:
   1. FAFSA Whats happening with 2024 college financial aid  CNN Politics
   2. Inside President Bidens pointed phone call with Benjamin Netanyahu  CNN Politics
   3. Trumps inflammatory rhetoric has been effective for him so far but poses real danger  CNN Politics
   4. Embittered Republicans plot to knock off House GOPs hardright leader in Virginia primary feud  CNN Politics
   5. Exclusive Hackers stole Russian prisoner database to avenge death of Navalny  CNN Politics
____________________________________________________________

You are currently in access to the list of articles in Politics,
   use command 'BACK' to return to main list of articles.
____________________________________________________________

What do you want from me?
____________________________________________________________

headlines 1
____________________________________________________________

Displaying the first 1 article headlines:
1. Kristen Wiig initiated into SNL fivetimers club by Ryan Gosling Matt Damon and Lorne Michaels  CNN
____________________________________________________________

What do you want from me?
____________________________________________________________

headlines 2
____________________________________________________________

Displaying the first 2 article headlines:
1. Kristen Wiig initiated into SNL fivetimers club by Ryan Gosling Matt Damon and Lorne Michaels  CNN
2. The Matrix has a fifth film in the works and no this is not a simulation  CNN
____________________________________________________________

What do you want from me?
____________________________________________________________

extract 1
____________________________________________________________

Article Extract: The already stressful college admissions process was thrown
into chaos this year by a botched bureaucratic upgrade Hiccups and delays in
the federal financial aid process have kept some high school seniors and
current college students from getting aid packages from schools
____________________________________________________________

What do you want from me?
____________________________________________________________

extract 2
____________________________________________________________

Article Extract: President Joe Bidenticked through several things that he
needed to see Israeli Prime Minister Benjamin Netanyahu do immediately Open up
the Erez crossing into northern Gaza and the port of Ashdod in southern Israel
for humanitarian aid and significantly ramp up the supplies getting in through
Kerem Shalom
____________________________________________________________

What do you want from me?
____________________________________________________________

back
____________________________________________________________

You have exited the list of articles in Politics
Currently in access to the main list of articles
____________________________________________________________

What do you want from me?
____________________________________________________________

extract 1
____________________________________________________________

Article Extract: Kristen Wiig got inducted into the coveted Saturday Night Live
fivetimers club in style this weekend when she hosted the longrunning NBC
sketch show for the fifth time and she had a little bit of help from some huge
stars
____________________________________________________________

What do you want from me?
____________________________________________________________

extract 2
____________________________________________________________

Article Extract: Red pill or blue pill anyone A fifth installment of the
beloved scifi film franchise The Matrix is in the works
____________________________________________________________

What do you want from me?
____________________________________________________________

As shown here, the command "extract" use the index based the filtered article list if the list is currently filtered, but the command "headlines" use the index based on the main(or whole) article list regardless. This inconsistency may cause confusion for users.


[original: nus-cs2113-AY2324S2/pe-interim#2083] [original labels: type.FunctionalityBug severity.Medium]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

This is a valid point and for more simplicity, we intend to implement this in future iterations this so that headlines cannot be accessed in other filtered lists. However, for now, we made sure that the app does not crash even if you input headline while in other lists. Furthermore, we made sure that the documentation clearly describes the purpose of the headlines feature so that the user's do not get confused:

The UG clearly mentions that the headlines feature uses the main list of articles:

image.png

Change of its functionality inside other features, such as filter or daily, has not been claimed. However, other features, such as get, url, extract will still use the filtered list when invoked inside a filtered list , and have been stated as such in the UG:

image.png

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]


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