Skip to content

Conversation

@anth-volk
Copy link
Contributor

Summary

This PR adds label metadata to example parameters across four categories that were identified as lacking proper labels. These fixes establish patterns for future work to ensure all parameters have human-readable labels.

Motivation: API v2 alpha aims to ensure all parameters have defined labels to improve trust for front-end users. Without proper labels, users see cryptic paths instead of meaningful descriptions.

Changes

Category File Fix
Breakdown without parent label gov/states/wi/tax/income/deductions/standard/max.yaml Added label
Bracket scale without label gov/irs/credits/education/american_opportunity_credit/amount.yaml Added label
Pseudo-breakdown gov/irs/income/amt/exemption/amount.yaml Added breakdown + label
Breakdown with range() gov/irs/deductions/itemized/salt_and_real_estate/state_sales_tax_table/tax.yaml Added breakdown_labels

Documentation

For detailed explanations of each category, before/after examples, and next steps, please see:
docs/PARAMETER_LABEL_METADATA_IMPROVEMENTS.md

Notes

  • The breakdown_labels field is a new metadata field that requires a corresponding update to policyengine.py to be fully functional
  • This PR fixes one example of each category; remaining parameters can be addressed in follow-up PRs

🤖 Generated with Claude Code

@codecov
Copy link

codecov bot commented Jan 5, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 75.74%. Comparing base (1c5414e) to head (21b668b).
⚠️ Report is 54 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff              @@
##              main    #7105       +/-   ##
============================================
- Coverage   100.00%   75.74%   -24.26%     
============================================
  Files            8     3649     +3641     
  Lines          128    52526    +52398     
  Branches         0      263      +263     
============================================
+ Hits           128    39785    +39657     
- Misses           0    12718    +12718     
- Partials         0       23       +23     
Flag Coverage Δ
unittests 75.74% <ø> (-24.26%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Collaborator

@hua7450 hua7450 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a changelog_entry to this PR.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should dele this file right?

@anth-volk
Copy link
Contributor Author

This PR is actually meant purely for demonstration and I should've marked it draft. It's intended to be closed.

@anth-volk anth-volk closed this Jan 9, 2026
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.

3 participants