Add docstrings to pipeweld objects and functions#1654
Open
Conversation
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
nathanjmcdougall
approved these changes
Mar 30, 2026
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
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.
The
_pipeweldmodule's public classes and methods lacked docstrings, which also blocks theexport-functions --stricthook.Added docstrings to all undocumented public symbols:
containers.py:Series,Parallel,DepGroupclassesops.py:BaseOperation,InsertParallel,InsertSuccessorclassesresult.py:WeldResultclassfunc.py:Partition,Adderclasses,Adder.add(),Adder.partition_component()methods