Skip to content

Clarify na_color docstring for groups= filtering behavior#640

Merged
timtreis merged 1 commit intomainfrom
fix/issue-600-na-color-groups-docs
May 7, 2026
Merged

Clarify na_color docstring for groups= filtering behavior#640
timtreis merged 1 commit intomainfrom
fix/issue-600-na-color-groups-docs

Conversation

@timtreis
Copy link
Copy Markdown
Member

@timtreis timtreis commented May 7, 2026

Fixes #600.

Summary

  • The old wording default "default" (gets set to "lightgray") implied that na_color="lightgray" was a no-op, but any explicit color enables the "show non-matching elements" path
  • Updated all three render functions (render_shapes, render_points, render_labels) to clearly state: omitting na_color hides non-matching elements; passing any explicit color shows them in that color
  • No code change — the behavior is correct and intentional

…ents (#600)

The previous wording "default (gets set to 'lightgray')" implied that
na_color="lightgray" was a no-op, but any explicit color enables the
"show non-matching elements" path. Rewrite all three render_* docstrings
to make this distinction clear.
@codecov-commenter
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 76.39%. Comparing base (f3e13b8) to head (16d701d).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #640   +/-   ##
=======================================
  Coverage   76.39%   76.39%           
=======================================
  Files          11       11           
  Lines        3237     3237           
  Branches      759      759           
=======================================
  Hits         2473     2473           
  Misses        466      466           
  Partials      298      298           
Files with missing lines Coverage Δ
src/spatialdata_plot/pl/basic.py 85.48% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@timtreis timtreis merged commit e1f8863 into main May 7, 2026
7 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

groups= filtering behavior changes silently when na_color='lightgray' is passed explicitly

2 participants