Skip to content

Reflow G6 iterator docstrings#68

Open
WilliamK112 wants to merge 1 commit into
graph-algorithms:masterfrom
WilliamK112:codex/planarity-g6-docstrings-60
Open

Reflow G6 iterator docstrings#68
WilliamK112 wants to merge 1 commit into
graph-algorithms:masterfrom
WilliamK112:codex/planarity-g6-docstrings-60

Conversation

@WilliamK112

Copy link
Copy Markdown

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

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.

1 participant