Reflow G6 iterator docstrings - #68
Merged
wbkboyer merged 2 commits intoAug 13, 2026
Merged
Conversation
…consistency. Also refined some of the descriptions to give hints for useage patterns of these methods.
wbkboyer
self-requested a review
August 12, 2026 23:59
wbkboyer
approved these changes
Aug 13, 2026
wbkboyer
left a comment
Member
There was a problem hiding this comment.
I made some additional tweaks, but the whole process was made smoother by your having broken out the short description line from each docstring!
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
sourceoftypo in the reader string initializer docstringTesting
git diff --cached --checkplanarity/full/g6IterationUtils.pyxdocstring summary shapecythonize(['planarity/full/g6IterationUtils.pyx'], build_dir=<temp>, force=True)with Cython 3.2.6 installed in a temporary directoryRefs #60