Skip to content

Add docstrings to pipeweld objects and functions#1654

Merged
nathanjmcdougall merged 3 commits intomainfrom
copilot/add-docstrings-to-pipeweld
Mar 31, 2026
Merged

Add docstrings to pipeweld objects and functions#1654
nathanjmcdougall merged 3 commits intomainfrom
copilot/add-docstrings-to-pipeweld

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 30, 2026 •
edited
Loading

The _pipeweld module's public classes and methods lacked docstrings, which also blocks the export-functions --strict hook.

Added docstrings to all undocumented public symbols:

  • containers.py: Series, Parallel, DepGroup classes
  • ops.py: BaseOperation, InsertParallel, InsertSuccessor classes
  • result.py: WeldResult class
  • func.py: Partition, Adder classes, Adder.add(), Adder.partition_component() methods

Copilot AI linked an issue Mar 30, 2026 that may be closed by this pull request
Add docstrings to pipeweld objects and functions #1653
Closed
@nathanjmcdougall
Add docstrings to pipeweld objects and functions
9a14231 
Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/77c2b8c8-97e2-4dbf-ab7b-19f4d090df64

Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
Copilot AI changed the title [WIP] Add docstrings to pipeweld objects and functions Add docstrings to pipeweld objects and functions Mar 30, 2026
Copilot AI requested a review from nathanjmcdougall March 30, 2026 22:19
@nathanjmcdougall nathanjmcdougall marked this pull request as ready for review March 30, 2026 22:22
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 30, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

@codspeed-hq
Copy link
Copy Markdown

codspeed-hq bot commented Mar 30, 2026 •
edited
Loading

Merging this PR will not alter performance

✅ 2 untouched benchmarks

Comparing copilot/add-docstrings-to-pipeweld (85b9323) with main (e9a5c2f)1

Open in CodSpeed

Footnotes

  1. No successful run was found on main (b949a41) during the generation of this report, so e9a5c2f was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩

@nathanjmcdougall nathanjmcdougall merged commit 6a813a7 into main Mar 31, 2026
20 checks passed
@nathanjmcdougall nathanjmcdougall deleted the copilot/add-docstrings-to-pipeweld branch March 31, 2026 22:40
Copilot AI mentioned this pull request Apr 1, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@nathanjmcdougall nathanjmcdougall nathanjmcdougall approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@nathanjmcdougall nathanjmcdougall

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add docstrings to pipeweld objects and functions

2 participants

@nathanjmcdougall