The terminal and HTML rendering of compare proxy hints is untested
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 82/100
Research direction
Read faircode/report.py at to_compare_terminal() and compare_to_html(), then inspect tests/test_report.py for how compare results are built and rendered. Add cases with permutation and chi2-capped proxy hints plus an HTML-special column name, asserting both renderers’ sections, notes, and escaping. Done when these assertions cover the reported gaps.
Written by the indexing model from the issue text.
Description
Where: faircode/report.py to_compare_terminal() (lines 346-352) and compare_to_html() (716-721), tests/test_report.py.
Current gap: coverage shows no test renders a compare result that has proxy_hints_a / proxy_hints_b: the "PROXY HINTS - A/B" sections of the terminal report and the "Proxy Hints" sections of the HTML report. The web compare HTML is covered by the parity test, but a regression in the Python renderers (a missing escape, a wrong p_method note) would not be noticed.
Repro:
$ python3 -m pytest tests -q -m "not slow" --cov=faircode.report --cov-report=term-missing | grep report.py
faircode/report.py ... 346-352, ... 716-721
Suggested approach: tests that build a compare result with hints (one permutation, one chi2-capped, one with an HTML-special column name) and assert the sections, the notes and the escaping in both renderers.
- Dominant language
- HTML
- Stars
- 47
- Forks
- 45
- Avg merge
- 3h 1m
- Merged PRs (30d)
- 53
Getting set up
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 yakew7/Fair-Code
-
enhancement good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
Maintainers usually reply within 1 day
-
enhancement good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
enhancement good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 79/100
Maintainers usually reply within 1 day
-
enhancement good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day
-
enhancement good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 79/100
Maintainers usually reply within 1 day
All issues in yakew7/Fair-Code
Similar issues
-
internal os specific
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
frostney/GocciaScript#1688 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
pytest-dev/pytest#15180 ·
Maintainers usually reply within 1 day
-
:maddi-inspection-kotlin:test runs out of heap in a full maddi test run; exit 1 with no failing testOpenbuild/ci front-end:kotlin
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
apache/rocketmq-dashboard#6712 ·
Maintainers usually reply within 3 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
agilepathway/label-checker#721 ·
Maintainers usually reply within 1 day