Docs and examples: CHANGELOG, README, API_REFERENCE, RECOMMENDATIONS, OMNL/transfer examples

Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
defiQUG
2026-02-23 03:48:39 -08:00
parent 8df772fab0
commit 439a5d9e51
8 changed files with 529 additions and 8 deletions

View File

@@ -62,13 +62,12 @@ Consolidated list of **missing components** (code/IPSAS/FQBM) and **documentatio
| Document | Status / remaining gap |
|----------|------------------------|
| **README.md** | No “Quick start” example with copy-paste code; no table of contents; Streamlit and scenarios could be in a single Optional features section. |
| **README.md** | Quick start, table of contents, and single Optional features section in place. |
| **docs/framework_summary.md** | One sentence per Part (IXVI) and module mapping in place. |
| **docs/IPSAS_COMPLIANCE.md** | Section 3 still says “L_cb not in state should say L_cb is in state. Compliance checklist could reference new helpers (comparative, notes, maturity/risk). |
| **docs/GAPS_AND_MISSING.md** | B.3 table says “repo multiplier not modeled” but `repo_multiplier()` exists could say “repo multiplier implemented; not in dashboard”. |
| **docs/IPSAS_COMPLIANCE.md** | L_cb in state; checklist references comparative, notes, maturity/risk, budget_actual_from_state; links to RECOMMENDATIONS. |
| **docs/GAPS_AND_MISSING.md** | Repo multiplier and dashboard noted; full CCP reference in RECOMMENDATIONS. |
| **docs/REFERENCES.md** | Weblinks added (IPSASB, Handbook, BIS, BIS bulk, IMF, Fed H.4.1, Fed Data Download). |
| **docs/RECOMMENDATIONS.md** | Created: consolidated list of recommendations and suggestions. |
| **Inline docstrings** | Some modules lack “Part X” references or “Required columns” for regression DataFrames. |
| **Inline docstrings** | Part X and Required columns added to empirical regressions; Part XII to capital_stress. |
---