docs: Add missing documentation for advanced outputs, economic impact analysis, and regions#256
Open
docs: Add missing documentation for advanced outputs, economic impact analysis, and regions#256
Conversation
… analysis, and regions Closes #255 - Add economic-impact-analysis.md: full baseline-vs-reform workflow, ChangeAggregate vs pipeline - Add advanced-outputs.md: DecileImpact, IntraDecileImpact, Poverty, Inequality, OutputCollection - Add regions-and-scoping.md: Region, RegionRegistry, scoping strategies, geographic impacts - Expand core-concepts.md: data loading, ensure() vs run(), Dynamic, simulation_modifier - Flesh out dev.md: setup, testing, CI, architecture overview - Update index.md and myst.yml TOC to include all pages (+ orphaned visualisation.md) - Align PR docs CI with production (MyST instead of Jupyter Book) - Add examples/us_budgetary_impact.py Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Create docs/examples.md embedding all example scripts via {literalinclude}
- Add examples page to myst.yml TOC
- Replace all "See examples/..." prose with links to examples.md sections
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #255
Adds documentation for ~40-50% of the public API that was previously undocumented:
economic_impact_analysis()workflow (US + UK),PolicyReformAnalysisreturn type,ChangeAggregatevs full pipeline, all filter optionsDecileImpact,IntraDecileImpact,Poverty(all types + demographic breakdowns),Inequality,OutputCollectionRegion,RegionRegistry,RowFilterStrategy,WeightReplacementStrategy,CongressionalDistrictImpact,ConstituencyImpact,LocalAuthorityImpactensure_datasets), simulation lifecycle (run()vsensure()),Dynamicclass,simulation_modifier, policy combinationvisualisation.mdto TOCexamples/us_budgetary_impact.pydemonstrating canonical US budgetary impact comparisonTest plan
myst build --htmlsucceeds indocs/directory🤖 Generated with Claude Code