Comma-delimited strings should be replaced by sequence of strings in the API, where applicable
Open
Nobody has claimed this yet.
API
source-breaker
- Dominant language
- Python
- Stars
- 128
- Forks
- 110
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 10
Description
Description of issue
In situations where input/output of API needs to to be multiple string items, basic sequence types (list, tuple, range, slice) should be preferred over comma-delimited strings, as they are semantically more accurate, e.g.:
- driver_setup
- group_capabilities
- supported_instrument_models
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 locating the API definitions for driver_setup, group_capabilities, and supported_instrument_models. Review how each currently represents multiple string items and determine which inputs and outputs are applicable. Done means the applicable APIs consistently use basic sequence types instead of comma-delimited strings, with behavior and compatibility implications documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, backend-api-design
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100