Fix docstrings

[networmix]

Summary

• keep function and class docs but ensure summary starts after """

Testing

• make format
• make check

[Copilot]

Pull Request Overview

This PR refactors existing docstrings by removing leading blank lines and placing the summary immediately after the opening """, improving consistency and adhering to style guidelines.

• Reformats class and function docstrings to inline the summary line.
• Ensures a blank line separates the summary from detailed sections (e.g., Args, Returns, Attributes).

Reviewed Changes

Copilot reviewed 33 out of 33 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
ngraph/lib/path.py	Inline class and method docstring summaries
ngraph/lib/io.py	Inline function docstring summaries
ngraph/lib/graph.py	Inline function and class docstring summaries
ngraph/lib/flow_policy.py	Inline class and method docstring summaries
ngraph/lib/flow.py	Inline class and method docstring summaries
ngraph/lib/demand.py	Inline class and method docstring summaries
ngraph/lib/algorithms/spf.py	Inline function docstring summaries
ngraph/lib/algorithms/place_flow.py	Inline class docstring summaries
ngraph/lib/algorithms/path_utils.py	Inline function docstring summaries
ngraph/lib/algorithms/max_flow.py	Inline function docstring summaries
ngraph/lib/algorithms/flow_init.py	Inline function docstring summaries
ngraph/lib/algorithms/edge_select.py	Inline function docstring summaries
ngraph/lib/algorithms/calc_capacity.py	Inline function docstring summaries
ngraph/lib/algorithms/base.py	Inline class docstring summaries
ngraph/failure_policy.py	Inline class and function docstring summaries
ngraph/failure_manager.py	Inline class and method docstring summaries
ngraph/explorer.py	Inline class and method docstring summaries
ngraph/components.py	Inline class and method docstring summaries
ngraph/cli.py	Expanded and inline main function docstring
ngraph/blueprints.py	Inline class and function docstring summaries

[cursor]

✅ BugBot reviewed your changes and found no bugs!

---

BugBot free trial expires on June 10, 2025
You have used $0.00 of your $50.00 spend limit so far. Manage your spend limit in the Cursor dashboard.

Was this report helpful? Give feedback by reacting with 👍 or 👎