docs: remove stale proceed parameter docs from tl.draw_graph - #4300
Merged
Conversation
proceed is documented in the docstring's Parameters section but was removed from the function signature; docs were never updated to match.
Codecov Report✅ All modified and coverable lines are covered by tests. 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
Flags with carried forward coverage won't be shown. Click here to find out more.
|
Member
|
thanks! |
proceed parameter docs from tl.draw_graphproceed parameter docs from tl.draw_graph
flying-sheep
enabled auto-merge (squash)
August 18, 2026 09:14
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
draw_graph's docstring documents a
proceedparameter, 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.