Skip to content

Commit cf8afa1

Browse files
committed
Polish briefing example copy
1 parent 7ef46dd commit cf8afa1

2 files changed

Lines changed: 19 additions & 6 deletions

File tree

examples/source_linked_briefing/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This example turns a Currents Search API response into two local files:
55
- `briefing.md` for a person to read;
66
- `briefing.json` for a dashboard, queue, or application-owned agent workflow.
77

8-
Every item keeps its publisher URL and publication time. The script does not call a language model, summarize full publisher articles, or make decisions for the reader.
8+
Every item keeps its source URL and publication time. The script does not call a language model, summarize full publisher articles, or make decisions for the reader.
99

1010
The example accompanies [Build a Source-Linked News Briefing with Currents Search API](https://currentsapi.services/en/blog/build-source-linked-news-briefing-currents-search-api).
1111

@@ -57,14 +57,14 @@ The Markdown output remains deliberately plain:
5757
```markdown
5858
# Source-Linked News Briefing
5959

60-
Generated at: 2026-07-25T00:00:00+00:00
60+
Generated at: 2026-07-25T00:00:00Z
6161

6262
- Battery storage policy enters public consultation - <https://example.com/energy/storage-policy>
6363
- Published: 2026-07-25T08:00:00Z
6464
- A fictional example describing a public policy consultation.
6565
```
6666

67-
The JSON output contains `generated_at` and a normalized `articles` list. Each article can contain:
67+
The JSON output contains `generated_at` and a normalized `articles` list. Each normalized article contains:
6868

6969
- `title`
7070
- `description`

examples/source_linked_briefing/briefing.py

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,22 @@
1111
def parse_args():
1212
parser = argparse.ArgumentParser(description=__doc__)
1313
parser.add_argument("--fixture", type=Path, help="Read a saved Search API response.")
14-
parser.add_argument("--keywords", default="artificial intelligence")
15-
parser.add_argument("--language", default="en")
16-
parser.add_argument("--output-dir", type=Path, default=Path("briefing-output"))
14+
parser.add_argument(
15+
"--keywords",
16+
default="artificial intelligence",
17+
help="Set the search terms for live mode.",
18+
)
19+
parser.add_argument(
20+
"--language",
21+
default="en",
22+
help="Set the article language for live mode.",
23+
)
24+
parser.add_argument(
25+
"--output-dir",
26+
type=Path,
27+
default=Path("briefing-output"),
28+
help="Choose where to write briefing.md and briefing.json.",
29+
)
1730
parser.add_argument(
1831
"--generated-at",
1932
help="Set the output timestamp for a custom fixture.",

0 commit comments

Comments
 (0)