Skip to content

docs: fix _merge_super_component_pipelines docstring (#12656) - #12992

Closed
Taranum01 wants to merge 1 commit into
deepset-ai:mainfrom
Taranum01:fix/12656-merge-super-component-docstring
Closed

Taranum01 wants to merge 1 commit into
deepset-ai:mainfrom
Taranum01:fix/12656-merge-super-component-docstring

Conversation

@Taranum01

Copy link
Copy Markdown

Summary

Fixes #12656.

The docstring on PipelineBase._merge_super_component_pipelines described a function that does not exist in the source: it referenced parameters (parent_pipeline, child_components, merge_strategy, warn_on_conflict) and a return shape that don't match the actual implementation. This PR rewrites the docstring to match the real signature and behavior.

No code changes; documentation only.

Changes

  • haystack/core/pipeline/base.py (around _merge_super_component_pipelines)
    • Rewrote the docstring to describe the actual parameters, return value, and side effects.
    • Aligned wording with the implementation (component-name collisions, graph mutation, warning emission).

Tests

No new tests added, per the maintainer note on the issue.

@Taranum01
Taranum01 requested a review from a team as a code owner September 27, 2026 22:59
@Taranum01
Taranum01 requested review from anakin87 and removed request for a team September 27, 2026 22:59
@vercel

vercel Bot commented Sep 27, 2026

Copy link
Copy Markdown
Contributor

Someone is attempting to deploy a commit to the deepset Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions

Copy link
Copy Markdown
Contributor

Hi @Taranum01, thanks for your interest in contributing to Haystack! 🙏

⛔ First-time contributors can have at most 1 open pull request in this repository until it has been approved, so this PR was closed automatically. Your open pull request #12991 is unaffected. Once it has been approved by a maintainer, you are welcome to open more PRs. Feel free to reopen this one at that point.

See the contributing guidelines for details.

This is an automated message to help us keep the review queue healthy.

@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


Taranum01 seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

_merge_super_component_pipelines docstring contradicts the function signature and implementation

2 participants