Update help message example to -p personalities.assistant
#71
Conversation
sylwia-budzynska
requested review from
JarLob,
Kwstubbs,
kevinbackhouse,
m-y-mo and
p-
as code owners
There was a problem hiding this comment.
Pull Request Overview
This PR attempts to update the help message example for the -p (personality) parameter from -p assistant to -p personalities.assistant. However, the change is incomplete.
Key Issue
- The updated example uses
personalities.assistant, but the correct format throughout the codebase isseclab_taskflow_agent.personalities.assistant(the full package path)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| help_msg = parser.format_help() | ||
| help_msg += "\nExamples:\n\n" | ||
| help_msg += "`-p assistant explain modems to me please`\n" | ||
| help_msg += "`-p personalities.assistant explain modems to me please`\n" |
There was a problem hiding this comment.
The example help message uses an incomplete personality reference. Based on the codebase, the correct format should be seclab_taskflow_agent.personalities.assistant (the full package path), not just personalities.assistant.
This is evident from:
- The README.md (line 71) which shows:
hatch run main -p seclab_taskflow_agent.personalities.assistant 'explain modems to me please' - The documentation (README.md lines 487-491) which explains that names like
seclab_taskflow_agent.personalities.assistantget split at the last.into package name and filename - The actual implementation in
available_tools.py(line 59-61) which splits on.and expects format"packagename.filename" - All taskflow YAML files throughout the codebase use the full format
seclab_taskflow_agent.personalities.assistant
The help message should use the same format to be consistent with actual usage.
| help_msg += "`-p personalities.assistant explain modems to me please`\n" | |
| help_msg += "`-p seclab_taskflow_agent.personalities.assistant explain modems to me please`\n" |
There was a problem hiding this comment.
I agree with @copilot. If you install with pip install seclab_taskflow_agent, then the correct name for the assistant is seclab_taskflow_agent.personalities.assistant.
There was a problem hiding this comment.
When running the docker container with the script, the way to run it would be with -p personalities.assistant explain modems to me please. We could consider unifying this and/or updating the docker docs too.
|
@kevinbackhouse I've opened a new pull request, #72, to work on those changes. Once the pull request is ready, I'll request review from you. |
No description provided.