changedOutput schema / properties / caveats / description
Previous value: -"Comparability warnings: a filer missing one or two calendar quarters from the frame-tagged series, a concept whose values stop at least two full years behind the rest of that company's reporting (either an XBRL tag SEC has retired, or a current tag the filer stopped using), period ends that differ inside one aligned period, concepts whose unit differs across companies, and — one line per concept — the companies that report a concept but have no value inside the inline periods, each with its newest period (its values are in the dataframe), and the concept inputs merged because they name the same concept. Company-specific warnings are prefixed with the company name. Empty when nothing needs flagging."New value: +"Comparability warnings (company-specific ones prefixed with the name), else empty: missing quarters; a concept stopping 2+ years behind the company's other reporting; period ends differing within a period; units differing across companies; values only before the inline window; merged inputs."
changedOutput schema / properties / cells / items / properties / frame / description
Previous value: -"Underlying XBRL frame, which differs from period for point-in-time concepts (e.g. frame CY2024Q3I under period CY2024)."New value: +"Underlying XBRL frame; differs from period for point-in-time concepts (CY2024Q3I under CY2024)."
changedOutput schema / properties / cells / items / properties / tag / description
Previous value: -"XBRL tag this value was reported under — one concept can walk several tags, so it can differ between periods of the same company."New value: +"XBRL tag this value was reported under; can differ between periods of one company."
changedOutput schema / properties / companies / items / description
Previous value: -"One company that resolved and contributed to the matrix."New value: +"One company that contributed to the matrix."
changedOutput schema / properties / concepts / description
Previous value: -"Concepts covered, in the order supplied. Inputs that name the same concept (revenue and Revenue, or one raw tag spelled twice) appear once, under the first spelling."New value: +"Concepts covered, in input order; inputs naming the same concept appear once, under the first spelling."
changedOutput schema / properties / concepts / items / properties / units / description
Previous value: -"Distinct units this concept resolved to across the companies. More than one means the values are not directly comparable — see caveats."New value: +"Units this concept resolved to across companies; more than one means values are not directly comparable."
changedOutput schema / properties / dataset / description
Previous value: -"Canvas dataframe holding the full aligned series across every period, not just the inline window. Columns match cells[]. Absent when canvas is unavailable."New value: +"Dataframe of the full aligned series, every period, with cells[] columns. Absent when canvas is unavailable."
changedOutput schema / properties / dataset / properties / name / description
Previous value: -"Dataframe handle (df_XXXXX_XXXXX) — inspect its columns with secedgar_dataframe_describe, then query it with secedgar_dataframe_query."New value: +"Dataframe handle (df_XXXXX_XXXXX) for secedgar_dataframe_describe, then secedgar_dataframe_query."
changedOutput schema / properties / failed_companies / description
Previous value: -"Companies excluded from the matrix. The comparison proceeds with the rest rather than failing the whole call."New value: +"Companies excluded from the matrix; the rest still compare."
changedOutput schema / properties / failed_companies / items / description
Previous value: -"One company that could not be included, with a machine-readable reason."New value: +"One company that could not be included."
changedOutput schema / properties / failed_companies / items / properties / reason / description
Previous value: -"Machine-readable failure. not_found: the input matched no CIK. ambiguous: it matched several, and the message lists them. no_company_facts: it resolved but the filer reports no XBRL. Match on this rather than the message."New value: +"not_found: no CIK matched. ambiguous: several matched; the message lists them. no_company_facts: resolved, but the filer reports no XBRL. Match on this, not the message."
changedOutput schema / properties / gaps / description
Previous value: -"Company-concept pairs with no value in any period. Deliberately explicit — a missing value is never interpolated or zero-filled. A pair with values only in periods older than the inline window is not a gap; caveats names it."New value: +"Company-concept pairs with no value in any period (never zero-filled). A pair with values only before the inline window appears in caveats instead."
changedOutput schema / properties / notice / description
Previous value: -"Guidance when the inline matrix dropped periods, or when the full aligned series is staged as a dataframe."New value: +"Guidance when the inline matrix dropped periods, or the full series is staged as a dataframe."
changedOutput schema / properties / periods / description
Previous value: -"Calendar period keys covered by the inline matrix, newest first. Shorter than the requested periods when the cell count forced the window to shrink — the enrichment trailer reports the drop."New value: +"Period keys in the inline matrix, newest first; shorter than requested when the cell count shrank it (see notice)."
changedOutput schema / properties / unknown_concepts / description
Previous value: -"Requested concepts that are neither a supported friendly name nor an XBRL tag (UpperCamelCase, e.g. NetIncomeLoss), reported once each rather than as a gap per company — secedgar_search_concepts lists every supported name. Empty when every concept resolved."New value: +"Concepts that are neither a supported name nor an XBRL tag, reported once instead of as per-company gaps; secedgar_search_concepts lists supported names. Empty when all resolved."
changedOutput schema / properties / unknown_concepts / items / properties / concept / description
Previous value: -"Concept as supplied (trimmed) — neither a supported friendly name nor an XBRL tag."New value: +"Concept as supplied, trimmed."
changedOutput schema / properties / unknown_concepts / items / properties / derivation / description
Previous value: -"How to build it from supported concepts when it is a standard combination, e.g. \"operating_cash_flow − capex\"."New value: +"How to build it from supported concepts, when it is a standard combination (e.g., \"operating_cash_flow − capex\")."