Skip to content

docs(financials): say why get_quarterly_financials() is None for a 6-K filer (GH #1824) - #1870

Merged
dgunning merged 1 commit into
mainfrom
docs/gh-1824-6k-quarterly
Nov 7, 2026
Merged

dgunning merged 1 commit into
mainfrom
docs/gh-1824-6k-quarterly

Conversation

@dgunning

@dgunning dgunning commented Nov 4, 2026

Copy link
Copy Markdown
Owner

What this changes

Company("TSM").get_quarterly_financials() returns None, because TSMC's quarterly results arrive on Form 6-K as an HTML press release with no XBRL. That's the 6.0 contract, but neither guide said so, and the 6-K guide told readers to "parse the press release exhibits directly" without naming the reader that does it. financial-data.md now has a section on foreign private issuers with a runnable EarningsRelease.from_filing() example, and the 6-K guide and the method docstring point to it. No behaviour change.

This covers the "clarify" half of #1824. The HTML fallback itself stays in #1825 for 6.1. Refs #1824

Verification

  • Ground truth: TSMC 6-K 0001046179-26-000726 (filed 2026-10-15), exhibit a3q26e_withguidancexfinal.htm, unit "NT$ million": 3Q26 net income 763,064 and 3Q25 452,302, read from the exhibit.
  • Regression test: tests/issues/regression/test_issue_1824_6k_quarterly_docs.py (docstring links get_quarterly_financials() returns None for TSM — clarify or improve the 6-K fallback #1824) runs the documented example as written and checks that the guide still shows it. It passes under -p tests._offline_harness.
  • Cassettes recorded from live SEC, not edited. This branch changes no runtime code, so recording on it is the same as recording on main. Recorded on: 2026-11-03. 1.76 MB, mostly the two full 6-K submissions.
  • Docs: the new example runs (that's the test above)
  • Changelog: none, because this is a docs-only change

hatch run test-fast: 50,547 passed, 5 failed. All 5 are in test_issue_282_xbrl_api_regression.py. They fail the same way on the unrelated #1869 branch and pass on their own, so they depend on test order on main. check-regression-provenance and check-cassettes pass.

6.0

No 6.0 change. This documents the existing None from docs/upgrade/6.0.md.

AI assistance

  • Assisted. Tool and model: Claude Code, Claude Opus 5.5

🤖 Generated with Claude Code

…K filer (GH #1824)

TSMC files its quarterly results on Form 6-K as an HTML press release
with no XBRL, so get_quarterly_financials() returns None, which is the
6.0 contract. Neither guide said so, and the 6-K guide told readers to
"parse the press release exhibits directly" without naming the reader
that does it.

financial-data.md gains a foreign-private-issuer section with a
runnable example on TSMC's 3Q26 release (0001046179-26-000726): net
income 763,064 vs 452,302, NT$ million as printed. The 6-K guide and the
method docstring point to EarningsRelease.from_filing(). A regression
test runs the example from a cassette recorded from live SEC.

The HTML fallback itself stays in #1825 for 6.1.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@dgunning
dgunning merged commit 0b70790 into main Nov 7, 2026
10 checks passed
@dgunning
dgunning deleted the docs/gh-1824-6k-quarterly branch November 7, 2026 01:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant