From 13b35e8aebf20aed4c47ecc73f05778a63cad118 Mon Sep 17 00:00:00 2001 From: Yijia-Xiao Date: Thu, 17 Sep 2026 07:31:44 +0000 Subject: [PATCH] docs: state the behaviour without the worked examples --- README.md | 2 +- tradingagents/dataflows/reddit.py | 4 ++-- tradingagents/dataflows/sec_edgar.py | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2d858d0cd..8c5ca7c63 100644 --- a/README.md +++ b/README.md @@ -244,7 +244,7 @@ See `tradingagents/default_config.py` for all configuration options. ### Fundamentals as filed -US company statements can come from SEC EDGAR, which records the date every figure was filed. A run dated in the past then reads the statements exactly as they stood that day: a fiscal year that has ended but has not been filed yet is not served, and a figure restated later still reads as first reported. Apple's 2008 total assets were filed as $39.6B and restated to $36.2B in 2010, and a run dated in between gets $39.6B. +US company statements can come from SEC EDGAR, which records the date every figure was filed. A run dated in the past then reads the statements exactly as they stood that day: a fiscal year that has ended but has not been filed yet is not served, and a figure restated later still reads as first reported. Apple's 2008 total assets were filed as $39.6B and restated to $36.2B in 2010, so a run dated in between reads $39.6B. EDGAR needs no account or API key. Add the vendor to the chain: diff --git a/tradingagents/dataflows/reddit.py b/tradingagents/dataflows/reddit.py index 9add68587..e01442853 100644 --- a/tradingagents/dataflows/reddit.py +++ b/tradingagents/dataflows/reddit.py @@ -78,8 +78,8 @@ _ATOM_NS = {"atom": "http://www.w3.org/2005/Atom"} DEFAULT_SUBREDDITS = ("wallstreetbets", "stocks", "investing") # Reddit's maximum page size. A week of posts for a ticker across the default -# subreddits fits comfortably (a busy symbol measured 12), so one full page keeps -# a high-volume subreddit from crowding the others out of a combined search. +# subreddits fits well inside one page, which keeps a high-volume subreddit from +# crowding the others out of a combined search. _FEED_PAGE = 100 diff --git a/tradingagents/dataflows/sec_edgar.py b/tradingagents/dataflows/sec_edgar.py index 245ec0241..2999f815d 100644 --- a/tradingagents/dataflows/sec_edgar.py +++ b/tradingagents/dataflows/sec_edgar.py @@ -7,8 +7,8 @@ figure that was later restated is not what investors saw at the time. EDGAR reports every fact with the date it was filed, so a run dated ``curr_date`` serves exactly what was on file by then, restatements included at the vintage -that was current. Apple's 2008 total assets read as 39.6B until the 2010 -amendment; a 2009 run should see 39.6B, and does. +that was current: Apple's 2008 total assets read 39.6B until the 2010 amendment +restated them to 36.2B. Access needs no key or account, only a User-Agent identifying the caller, which SEC requires and refuses requests without. US filers only: anything absent from