Clean up types of numbers in the position interface
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 75/100
- Issue type
- Refactor
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- typescript
- Domain
- frontend
Research direction
Start with src/types/position.ts at the linked definitions, then inspect the related discussion in atlas pull request 84 and usages of the position interface. Update the types so numeric values can be passed as numbers, retaining string compatibility only if required; done means the acceptance criteria are met without breaking existing callers.
Written by the indexing model from the issue text.
Description
As someone using cs-web-lib in my app it's confusing that parameters that I would naturally expect to be numbers are expected to be passed in as strings e.g. many of the items in https://github.com/DiamondLightSource/cs-web-lib/blob/b307d188133c1df647f08c2401d9edca487ecf69/src/types/position.ts#L8. See initial confusion at https://github.com/DiamondLightSource/atlas/pull/84#discussion_r3473737603.
Acceptance Criteria
- We can pass these values in as numbers
- If we must keep backwards compatibility we still allow strings but ideally I feel like they should be typed as just numbers
- Dominant language
- TypeScript
- Stars
- 5
- Forks
- 4
- Avg merge
- 3d 59m
- Merged PRs (30d)
- 3
Contributor guide
No contributing guide indexed for this repository
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.
More from DiamondLightSource/cs-web-lib
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
DiamondLightSource/cs-web-lib#51 · 2 comments ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
-
priority:3
Difficulty 1/5 Under an hour Newbie friendliness 25/100
-
priority:2
DiamondLightSource/cs-web-lib#37 · 1 assignee ·
-
enhancement priority:3
Difficulty 5/5 Over a week Newbie friendliness 35/100
All issues in DiamondLightSource/cs-web-lib
Similar issues
-
calcite-components needs triage refactor
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Esri/calcite-design-system#15203 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 91/100
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Automattic/studio#4908 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100