Skip to content

Add support for custom row labels#333

Merged
tpvasconcelos merged 11 commits into
mainfrom
y_labels
Aug 30, 2025
Merged

Add support for custom row labels#333
tpvasconcelos merged 11 commits into
mainfrom
y_labels

Conversation

@tpvasconcelos

@tpvasconcelos tpvasconcelos commented Aug 29, 2025

Copy link
Copy Markdown
Owner

Add support for custom row labels (via a new row_labels argument) and deprecated the show_yticklabels argument.

related to #315


📚 Documentation preview 📚: https://ridgeplot--333.org.readthedocs.build/en/333/

@github-actions

This comment has been minimized.

@codecov

codecov Bot commented Aug 29, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (4da7ba2) to head (34ba839).
⚠️ Report is 122 commits behind head on main.

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     
Flag Coverage Δ
combined-src 99.84% <100.00%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@tpvasconcelos tpvasconcelos changed the title wip: y labels Add support for custom row labels Aug 29, 2025
@tpvasconcelos
tpvasconcelos requested a review from Copilot August 30, 2025 01:22

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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_yticklabels boolean parameter with row_labels Collection[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.

Comment thread src/ridgeplot/_ridgeplot.py Outdated
Comment thread docs/getting_started/getting_started.md
Comment thread README.md
Comment thread cicd_utils/ridgeplot_examples/_lincoln_weather.py
@tpvasconcelos
tpvasconcelos marked this pull request as ready for review August 30, 2025 03:43
@tpvasconcelos
tpvasconcelos merged commit 476c599 into main Aug 30, 2025
20 checks passed
@tpvasconcelos
tpvasconcelos deleted the y_labels branch August 30, 2025 05:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants