PolicyEngine / PolicyEngine/policyengine-uk
Show parameter references
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 50
- Forks
- 33
- Avg merge
- 20h 58m
- Merged PRs (30d)
- 14
Description
Currently, parameters show only their default values. It would be helpful to have an (i) symbol, which on hover or click shows the references for a particular parameter. In OpenFisca, parameters with references have the structure:
description:
values:
...
metadata:
reference:
- title: Reference title
href: https://reference.gov/link
Adding this will require:
- Ensuring reference metadata is passed from the
/parametersendpoint - Showing the hover-over card and the (i) component with the relevant links
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing the /parameters endpoint and how parameter metadata is delivered to the interface. Then locate the parameter display component and verify that reference metadata reaches the hover or click card; done means parameters with references show an (i) control and relevant links, while parameters without references remain usable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, frontend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100