Skip to content

Commit 2cf35cd

Browse files
fix(examples): address reviewer feedback for scientific writing examples
- Fix citation tool to use LaTeX \textit{} instead of Markdown italics - Correct YAML CLI command from non-existent --file flag to proper praisonai run - Remove misapplied noqa: E402 comment and replace with descriptive text Addresses feedback from Gemini and Greptile code reviews. Co-authored-by: Mervin Praison <MervinPraison@users.noreply.github.com>
1 parent 4222121 commit 2cf35cd

3 files changed

Lines changed: 3 additions & 3 deletions

File tree

examples/scientific_writing/agents.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Scientific paper workflow — YAML equivalent of multi_agent_paper.py
22
# Run with:
3-
# praisonai agents run --file examples/scientific_writing/agents.yaml
3+
# praisonai run examples/scientific_writing/agents.yaml
44
framework: praisonai
55
topic: "Climate change effects on coral reef biodiversity"
66

examples/scientific_writing/multi_agent_paper.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"""
1111
from praisonaiagents import Agent, AgentTeam, Task
1212

13-
from scientific_writer import ( # noqa: E402 — example imports a sibling file
13+
from scientific_writer import ( # sibling-file import; works when run from this directory
1414
build_scientific_writer,
1515
format_citation,
1616
format_latex_section,

examples/scientific_writing/scientific_writer.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ def format_citation(authors: str, year: int, title: str, venue: str) -> str:
4242
Returns:
4343
One APA-formatted citation string.
4444
"""
45-
return f"{authors} ({year}). {title}. *{venue}*."
45+
return f"{authors} ({year}). {title}. \\textit{{{venue}}}."
4646

4747

4848
SCIENTIFIC_INSTRUCTIONS = """You are a specialised scientific paper writer.

0 commit comments

Comments
 (0)