Skip to content

docs: remove stale proceed parameter docs from tl.draw_graph - #4300

Merged
flying-sheep merged 2 commits into
scverse:mainfrom
RohitKattimani:main
Aug 18, 2026
Merged

docs: remove stale proceed parameter docs from tl.draw_graph#4300
flying-sheep merged 2 commits into
scverse:mainfrom
RohitKattimani:main

Conversation

@RohitKattimani

Copy link
Copy Markdown
Contributor

draw_graph's docstring documents a proceed parameter, but it is not part of the function's actual signature. Git history shows that it used to be a real parameter (proceed: bool, optional) and was later removed from the code, but the docstring was not updated.

I found this through numpydoc.validate() and confirmed that this is a genuine documentation drift, rather than the shared {show_save_ax}-style doc template used elsewhere in the plotting module, where parameters like ax are intentionally documented even though they are passed through **kwds.

  • Closes #
  • Tests included or not required because: documentation-based change
  • Release notes not necessary because: documentation-based change

proceed is documented in the docstring's Parameters section but was removed from the function signature; docs were never updated to match.
@codecov

codecov Bot commented Aug 17, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.01%. Comparing base (4ab45dc) to head (abd94f0).
⚠️ Report is 1 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4300   +/-   ##
=======================================
  Coverage   80.01%   80.01%           
=======================================
  Files         132      132           
  Lines       13397    13397           
=======================================
  Hits        10719    10719           
  Misses       2678     2678           
Flag Coverage Δ
hatch-test.low-vers 78.23% <ø> (ø)
hatch-test.pre 79.88% <ø> (ø)

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

Files with missing lines Coverage Δ
src/scanpy/tools/_draw_graph.py 69.86% <ø> (ø)

@flying-sheep

Copy link
Copy Markdown
Member

thanks!

@flying-sheep flying-sheep added this to the 1.12.4 milestone Aug 18, 2026
@flying-sheep flying-sheep changed the title DOCS: remove stale proceed parameter docs from tl.draw_graph docs: remove stale proceed parameter docs from tl.draw_graph Aug 18, 2026
@flying-sheep
flying-sheep enabled auto-merge (squash) August 18, 2026 09:14
@flying-sheep
flying-sheep merged commit 6b5405d into scverse:main Aug 18, 2026
16 of 18 checks passed
@scverse scverse deleted a comment from lumberbot-app Bot Aug 18, 2026
@flying-sheep flying-sheep modified the milestones: 1.12.4, 1.13.0 Aug 18, 2026
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