Merge pull request #855 from gaoflow/fix-currency-short-rollover

fix(formatting): roll format_currency_short up to the next unit at boundaries

Author: dgunning

CHANGELOG.md

@@ -17,6 +17,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - **`FormC.filer_information.ccc` no longer duplicates the CIK** — the Form C parser read the `filerCik` element into both `cik` and `ccc`; `ccc` now reads the actual `filerCcc` element (always redacted to `XXXXXXXX` in disseminated filings) and is `Optional`, returning `None` when absent.
 - **`FormC.filer_information.live_or_test` is no longer always `False`** — the parser looked for a `testOrLive` element under `filer`, but the schema places `liveTestFlag` under `filerInfo`; LIVE filings now correctly report `True` (older `testOrLive` documents remain supported).
 - **TTM Q4 derivation no longer produces wrong/negative values for discrete-quarter reporters** — when a concept is reported as discrete quarters with no cumulative 9-month YTD fact (common for BDCs and investment companies), `TTMCalculator` derives Q4 as `FY - (Q1+Q2+Q3)`. It previously selected the three input quarters by their `fiscal_period` label, but the SEC tags comparative facts in re-filings with the *filing's* fiscal period, so the same calendar quarter could appear labeled Q1, Q2 and Q3 across successive 10-Qs — producing a wrong, often negative Q4 (e.g. GAIN `InvestmentCompanyDividendDistribution`: `57.2M - 3×28.8M = -29.2M`). Quarters are now selected by distinct calendar period (dedup by `period_end`, latest periodic filing wins), and derivation is skipped when a discrete Q4 is already reported. This affects `quarterize()`, TTM calculations, and quarterly statement views. ([#848](https://github.com/dgunning/edgartools/issues/848))
+- **`format_currency_short` rolls up to the next unit at magnitude boundaries** — a value just under 1B (>= ~999.95M) rounded to `1,000.0` within the millions bucket and rendered as the nonsensical `$1,000.0M` instead of `$1.0B`; it now promotes to the billions unit when the millions mantissa rounds up to 1,000.
 
 ### Changed
 

edgar/display/formatting.py

@@ -101,7 +101,13 @@ def format_currency_short(value: Union[int, float, Decimal, None], currency: str
     if abs_val >= 1_000_000_000:
         return f"{sign}{currency}{abs_val / 1_000_000_000:,.1f}B"
     elif abs_val >= 1_000_000:
-        return f"{sign}{currency}{abs_val / 1_000_000:,.1f}M"
+        scaled = abs_val / 1_000_000
+        # A value just under 1B (>= ~999.95M) rounds to "1,000.0M" at one
+        # decimal place; promote it to "1.0B" rather than render the
+        # nonsensical "1,000.0M".
+        if round(scaled, 1) >= 1000:
+            return f"{sign}{currency}{abs_val / 1_000_000_000:,.1f}B"
+        return f"{sign}{currency}{scaled:,.1f}M"
     elif abs_val >= 1_000:
         return f"{sign}{currency}{abs_val:,.0f}"
     else:

tests/test_to_context.py

@@ -46,6 +46,19 @@ def test_boundary_million(self):
     def test_boundary_billion(self):
         assert format_currency_short(1_000_000_000) == "$1.0B"
 
+    def test_high_millions_not_promoted(self):
+        # Comfortably under 1B: stays in millions.
+        assert format_currency_short(999_000_000) == "$999.0M"
+
+    def test_just_under_billion_promotes_to_b(self):
+        # Values that round up to "1,000.0M" must roll over to "1.0B"
+        # instead of rendering the nonsensical "$1,000.0M".
+        assert format_currency_short(999_950_000) == "$1.0B"
+        assert format_currency_short(999_999_999) == "$1.0B"
+
+    def test_just_under_billion_promotes_negative(self):
+        assert format_currency_short(-999_950_000) == "-$1.0B"
+
 
 class TestTenKToContext:
     """Tests for TenK.to_context() using a known filing."""