Skip to content

Reflow G6 iterator docstrings - #68

Merged
wbkboyer merged 2 commits into
graph-algorithms:masterfrom
WilliamK112:codex/planarity-g6-docstrings-60
Aug 13, 2026
Merged

Reflow G6 iterator docstrings#68
wbkboyer merged 2 commits into
graph-algorithms:masterfrom
WilliamK112:codex/planarity-g6-docstrings-60

Conversation

@WilliamK112

Copy link
Copy Markdown
Contributor

Summary

  • reflow G6 read/write iterator docstrings so each starts with a short summary sentence
  • move longer details into separate paragraphs for cleaner API documentation rendering
  • fix the touched sourceof typo in the reader string initializer docstring

Testing

  • git diff --cached --check
  • custom parser check for planarity/full/g6IterationUtils.pyx docstring summary shape
  • cythonize(['planarity/full/g6IterationUtils.pyx'], build_dir=<temp>, force=True) with Cython 3.2.6 installed in a temporary directory

Refs #60

WilliamK112 and others added 2 commits July 13, 2026 22:02
…consistency. Also refined some of the descriptions to give hints for useage patterns of these methods.
@wbkboyer
wbkboyer self-requested a review August 12, 2026 23:59

@wbkboyer wbkboyer left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made some additional tweaks, but the whole process was made smoother by your having broken out the short description line from each docstring!

@wbkboyer
wbkboyer merged commit dd36363 into graph-algorithms:master Aug 13, 2026
5 checks passed
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