Add support for custom row labels#333
Conversation
This comment has been minimized.
This comment has been minimized.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #333 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 18 18
Lines 646 655 +9
Branches 78 83 +5
=========================================
+ Hits 646 655 +9
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull Request Overview
This PR introduces support for custom row labels in ridgeline plots and deprecates the existing show_yticklabels parameter in favor of the new row_labels parameter. The new parameter allows users to specify custom labels for each row, automatically generate them from trace labels, or disable them entirely.
- Replace
show_yticklabelsboolean parameter withrow_labelsCollection[str] | None | Literal[False] - Add deprecation warnings and migration logic for the old parameter
- Update documentation and examples to use the new parameter
Reviewed Changes
Copilot reviewed 9 out of 13 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
src/ridgeplot/_ridgeplot.py |
Added row_labels parameter, deprecated show_yticklabels, and added migration logic |
src/ridgeplot/_figure_factory.py |
Updated function signatures and logic to use row_labels instead of show_yticklabels |
tests/unit/test_ridgeplot.py |
Added comprehensive test coverage for the new row_labels functionality |
tests/unit/test_figure_factory.py |
Updated test to reflect the new function signature |
tests/e2e/artifacts/basic_hist.json |
Updated test artifact to reflect changes in y-axis tick formatting |
tox.ini |
Lowered code coverage threshold from 75% to 74% |
| Documentation and example files | Updated to use row_labels instead of labels parameter |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Add support for custom row labels (via a new
row_labelsargument) and deprecated theshow_yticklabelsargument.related to #315
📚 Documentation preview 📚: https://ridgeplot--333.org.readthedocs.build/en/333/