Fix docstrings #75
Merged
Fix docstrings #75
Conversation
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
There was a problem hiding this comment.
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[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
✅ 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 👎
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
"""Testing
make formatmake check