[315] Legend groups

[tpvasconcelos]

Closes #315

---

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

[github-actions]

⚠️ Missing changelog entry ⚠️

Please add an entry to the changelog in docs/reference/changelog.md for this PR.
The entry should be in the following format:

- Description of the change ({gh-pr}`349`)

If you don't think a changelog entry is necessary for this change, you can add a skip news label to this PR.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (58e008c) to head (8c0b821).

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #349   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           18        19    +1     
  Lines          659       701   +42     
  Branches        85        87    +2     
=========================================
+ Hits           659       701   +42     

Flag	Coverage Δ
combined-src	100.00% <100.00%> (ø)

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]

@codex Review this PR

[Copilot]

Pull Request Overview

This PR adds legend grouping functionality to ridgeplot, allowing traces with the same labels to share legend entries. The change introduces a new legendgroup parameter to control whether traces sharing the same name should be grouped together in the legend.

• Adds a legendgroup boolean parameter to control legend entry grouping behavior
• Refactors trace creation to use a new LegendContext system for managing legend properties
• Updates examples and documentation to demonstrate the new legend grouping feature

Reviewed Changes

Copilot reviewed 13 out of 21 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
src/ridgeplot/_ridgeplot.py	Adds legendgroup parameter to main ridgeplot function
src/ridgeplot/_figure_factory.py	Integrates LegendContextManager to handle legend grouping logic
src/ridgeplot/_obj/legendcontext.py	New module defining legend context management classes
src/ridgeplot/_obj/traces/base.py	Refactors trace base class to use LegendContext instead of string labels
src/ridgeplot/_obj/traces/bar.py	Updates bar trace implementation to use new legend context system
src/ridgeplot/_obj/traces/area.py	Updates area trace implementation to use new legend context system
tests/unit/test_ridgeplot.py	Adds test for legend grouping functionality
tests/unit/test_figure_factory.py	Updates factory tests to include new legendgroup parameter
tests/unit/obj/traces/test_bar.py	Updates bar trace tests to use new LegendContext
tests/e2e/artifacts/basic_hist.json	Updates test artifact with new showlegend properties
docs/getting_started/getting_started.md	Updates documentation examples to use legendgroup feature
cicd_utils/ridgeplot_examples/_lincoln_weather.py	Updates example to demonstrate legendgroup usage
cicd_utils/ridgeplot_examples/_lincoln_weather_red_blue.py	Updates color mapping to use new label names

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[Copilot]

The TODO comment suggests this parameter needs documentation and a better name. The current name 'legendgroup' and the boolean type don't clearly convey that this enables grouping of legend entries by label name.

[Copilot]

The commented FIXME indicates that legendgrouptitle functionality is not working as expected. This suggests there may be an issue with the Plotly legend group title feature that should be investigated or documented.

[chatgpt-codex-connector]

Codex Review: Didn't find any major issues. Bravo.

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

• Open a pull request for review
• Mark a draft as ready
• Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting

• @codex fix this CI failure
• @codex address that feedback

[tpvasconcelos]

@codex pick a better name for the new parameter and document it in the ridgeplot docstring

[chatgpt-codex-connector]

Summary

• Renamed the public ridgeplot parameter to group_legend_by_label and documented how it consolidates legend entries when enabled. src/ridgeplot/_ridgeplot.pyL100-L226
• Propagated the new legend-grouping option through the figure factory, legend context manager, tests, documentation, examples, and changelog so the clearer name is used consistently. src/ridgeplot/_figure_factory.pyL123-L182 src/ridgeplot/_obj/legendcontext.pyL38-L60 tests/unit/test_ridgeplot.pyL142-L166 tests/unit/test_figure_factory.pyL123-L138 docs/getting_started/getting_started.mdL134-L145 cicd_utils/ridgeplot_examples/_lincoln_weather.pyL28-L39 docs/reference/changelog.mdL5-L9

Testing

• ⚠️ pytest tests/unit/test_ridgeplot.py::test_traces_share_legend_entries (fails: missing pytest_cov module in environment)

View task →