Skip to content

Clarify na_color docstring for groups= filtering behavior#639

Closed
timtreis wants to merge 1 commit intomainfrom
fix/issue-600-na-color-groups-docs
Closed

Clarify na_color docstring for groups= filtering behavior#639
timtreis wants to merge 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.
@timtreis timtreis force-pushed the fix/issue-600-na-color-groups-docs branch from f2c3e62 to 5e3eb40 Compare May 7, 2026 16:22
@timtreis
Copy link
Copy Markdown
Member Author

timtreis commented May 7, 2026

Closing to reopen with a clean branch.

@timtreis timtreis closed this May 7, 2026
@timtreis timtreis deleted the fix/issue-600-na-color-groups-docs branch May 7, 2026 16:25
@codecov-commenter
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 76.36%. Comparing base (f3e13b8) to head (5e3eb40).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #639      +/-   ##
==========================================
- Coverage   76.39%   76.36%   -0.04%     
==========================================
  Files          11       11              
  Lines        3237     3237              
  Branches      759      759              
==========================================
- Hits         2473     2472       -1     
  Misses        466      466              
- Partials      298      299       +1     
Files with missing lines Coverage Δ
src/spatialdata_plot/pl/basic.py 85.48% <ø> (ø)

... and 1 file with indirect coverage changes

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

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.

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

3 participants