Skip to content

docs: fix _merge_super_component_pipelines return description - #13011

Merged
anakin87 merged 1 commit into
deepset-ai:mainfrom
Morningstar202604:fix-super-component-docstring
Oct 2, 2026
Merged

anakin87 merged 1 commit into
deepset-ai:mainfrom
Morningstar202604:fix-super-component-docstring

Conversation

@Morningstar202604

Copy link
Copy Markdown
Contributor

Fixes #12656.

Corrects the :returns: section of _merge_super_component_pipelines to match the actual signature (tuple[networkx.MultiDiGraph, dict[str, str]]):

  • removes the non-existent middle return value (the "boolean indicating" dictionary),
  • fixes the description of the second value (a dict[str, str] mapping component names to their SuperComponent name),
  • fixes a small "all it's" -> "all its" typo.

Docs-only change, no behavior or tests affected (per the maintainer's note in the issue).

Disclosure: I used AI tools to help draft this change.

@Morningstar202604
Morningstar202604 requested a review from a team as a code owner September 29, 2026 05:32
@Morningstar202604
Morningstar202604 requested review from anakin87 and removed request for a team September 29, 2026 05:32
@vercel

vercel Bot commented Sep 29, 2026

Copy link
Copy Markdown
Contributor

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

A member of the Team first needs to authorize it.

@CLAassistant

CLAassistant commented Sep 29, 2026 •

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@HaystackBot

Copy link
Copy Markdown
Contributor

Hi @Morningstar202604, thanks a lot for your contribution! 🙏

We noticed that the Contributor License Agreement (CLA) check (license/cla) hasn't passed yet, so we've temporarily moved this PR to draft and paused the review assignment.

To get your PR reviewed, please sign the CLA via the link in the license/cla check below (or in the CLA bot comment). As soon as the check turns green, this PR will automatically be marked ready for review again and a reviewer will be re-assigned.

@HaystackBot
HaystackBot removed the request for review from anakin87 September 29, 2026 06:47
@HaystackBot HaystackBot added the cla-pending PR is in draft until the contributor signs the CLA label Sep 29, 2026
@HaystackBot
HaystackBot marked this pull request as draft September 29, 2026 06:47
@HaystackBot
HaystackBot marked this pull request as ready for review October 2, 2026 10:30
@HaystackBot
HaystackBot requested a review from anakin87 October 2, 2026 10:30
@HaystackBot HaystackBot removed the cla-pending PR is in draft until the contributor signs the CLA label Oct 2, 2026
@HaystackBot

Copy link
Copy Markdown
Contributor

Thanks for signing the CLA, @Morningstar202604! 🎉 This PR is now ready for review again and the reviewer has been re-assigned.

@anakin87 anakin87 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@github-actions github-actions Bot added the type:documentation Improvements on the docs label Oct 2, 2026
@anakin87
anakin87 enabled auto-merge (squash) October 2, 2026 10:37
@anakin87
anakin87 merged commit 7dc6a0a into deepset-ai:main Oct 2, 2026
38 of 39 checks passed
@github-actions

github-actions Bot commented Oct 2, 2026

Copy link
Copy Markdown
Contributor

Coverage report

Click to see where and how coverage changed

FileStatementsMissingCoverageCoverage
(new stmts)
Lines missing
  haystack/components/builders
  chat_prompt_builder.py
  haystack/components/joiners
  branch.py
  haystack/components/preprocessors
  document_splitter.py
  embedding_based_document_splitter.py
  markdown_header_splitter.py
  recursive_splitter.py
  haystack/components/rankers
  meta_field_grouping_ranker.py
  haystack/components/routers
  conditional_router.py
  haystack/core/pipeline
  base.py 1799
  haystack/document_stores/in_memory
  document_store.py
  haystack/utils
  misc.py
Project Total  

This report was generated by python-coverage-comment-action

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

Labels

topic:core type:documentation Improvements on the docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

_merge_super_component_pipelines docstring contradicts the function signature and implementation

4 participants