StarNewsFinder example is confusing

[xak2000]

Hello, I'm just starting the investigation of this library.

I found StarNewsFinder example is very confusing.

First, the class name. StarNewsFinder means that the main responsibility of the agent to find "star news". This is also confirmed by the description:

@Agent(description = "Find news based on a person's star sign")
public class StarNewsFinder {

One of the actions defined (findNewsStories) really does this (finds news):

    @Action  
    public RelevantNewsStories findNewsStories(

But here is the confusion. This is not the main action. The main action that achieves the goal is this:

    @AchievesGoal(description = "Write an amusing writeup based on horoscope and news")  
    @Action
    public Writeup writeup(

Is it correct?

If this is correct, then why the class is called StarNewsFinder and not StarNewsStoryWriter (or similar)? IIUC this is the main goal of the @Agent. Not finding the news, but writing the story based on the found news. Finding the news is just an intermediate action needed to achieve the writeup goal.

Please correct me if I'm wrong. I'm really trying to understand, but this confusion doesn't make it easier. :)

[xak2000]

@alexheifetz Well, it's not exactly a duscussion/question. Rather a request to rename StarNewsFinder to StarNewsStoryWriter (or something like this) or in case I'm wrong and the class name is correct, then better explain in the docs why the class name and agent description has nothing to do with the goal.

[alexheifetz]

Agreed. Let's treat this one as an issue.

[alexheifetz]

Agreed. Let's treat this one as an issue.