feat: forward stat function docstrings to stat objects#708
Merged
Conversation
H.nodes.degree? now shows the actual degree docstring instead of the generic NodeStat class docstring. Closes #357 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Collaborator
Author
|
As requested by @maximelucas recently |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #708 +/- ##
=======================================
Coverage 93.62% 93.62%
=======================================
Files 66 66
Lines 5161 5162 +1
=======================================
+ Hits 4832 4833 +1
Misses 329 329 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
nwlandry
approved these changes
Apr 26, 2026
nwlandry
left a comment
Collaborator
There was a problem hiding this comment.
This is awesome, @leotrs! Good to merge, but this makes me wonder if we should remind users somewhere in the docs (maybe quickstart.ipynb or something?) that using the ? is helpful? But this is a separate issue that we could talk about tomorrow in the team meeting.
maximelucas
approved these changes
Apr 27, 2026
This was referenced May 27, 2026
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.
Summary
H.nodes.degree?now shows the actual degree docstring (parameters, description) instead of the genericNodeStatclass docstringself.__doc__ = func.__doc__inIDStat.__init__Closes #357 (the last remaining point — discoverability was addressed by #699)
Test plan
test_stat_docstring_forwardingcovers node stats, edge stats, args preservation, custom stats, and directed hypergraph stats