Validate measures_labels length in correlation analysis
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
Research direction
Start by reading src/circumplex/analysis/corr_analysis.py:107-110 and the downstream label construction at lines 228-268. Add tests for matching and mismatched custom label lengths, then run the relevant test suite; done means mismatches raise a clear ValueError while valid lengths continue successfully.
Written by the indexing model from the issue text.
Description
Summary
corr_analysis() accepts measures_labels, but it does not validate that the labels list matches the number of measures.
Problem
measures_labels is used downstream to build labels for results rows, but there is no explicit length check against measures. A mismatched list can lead to malformed labels or downstream shape/logic errors.
Evidence
src/circumplex/analysis/corr_analysis.py:107-110- downstream label construction in
src/circumplex/analysis/corr_analysis.py:228-268
Proposed work
- Validate that
len(measures_labels) == len(measures)whenever custom labels are provided. - Raise a clear
ValueErrorwhen the lengths do not match. - Add tests covering mismatched and valid label lengths.
Acceptance criteria
- Invalid
measures_labelslength is caught immediately with a clear error. - Tests cover both success and failure cases.
- Dominant language
- Python
- Stars
- 2
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
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 MitchellAcoustics/circumplex
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 4/5 3-5 days Newbie friendliness 55/100
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
-
Difficulty 3/5 1-2 days Newbie friendliness 58/100
-
Difficulty 3/5 1-2 days Newbie friendliness 72/100
All issues in MitchellAcoustics/circumplex
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100