Skip to content

Spectral layout docstring - #438

Open
karlmoresco wants to merge 2 commits into
devfrom
feature/spectral-layout-docstring
Open

Spectral layout docstring#438
karlmoresco wants to merge 2 commits into
devfrom
feature/spectral-layout-docstring

Conversation

@karlmoresco

@karlmoresco karlmoresco commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Description

Updated the spectral_layout docstring with details and information about arguments, returns, raises etc.

PR checklist:

  • This comment contains a description of changes
  • I have performed a self-review of my own code
  • My changes generate no new warnings
  • I have checked my code and documentation and corrected any misspellings

Note

Low Risk
Docstring-only change with no behavioral impact on layout computation or callers.

Overview
Expands the spectral_layout docstring in _networkx.py from a single-line description to full API documentation.

The update explains how spectral layout uses Laplacian eigenvectors, documents g, dim, normalize, seed, and method (eigen vs psvd), and describes the returned node→coordinate mapping. It also lists ValueError cases that match existing validation (graph size/connectivity, dim, method/normalize pairing, and method-specific size or bipartite/pixel_type constraints).

No runtime or algorithm changes—documentation only.

Reviewed by Cursor Bugbot for commit 8ae3f93. Bugbot is set up for automated code reviews on this repo. Configure here.

@karlmoresco karlmoresco mentioned this pull request Aug 7, 2026
6 tasks
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