Skip to content

docs: clarify that BranchJoiner expects only one branch to produce output per run - #13287

Merged
sjrl merged 2 commits into
mainfrom
docs/branchjoiner-single-branch
Oct 16, 2026
Merged

sjrl merged 2 commits into
mainfrom
docs/branchjoiner-single-branch

Conversation

@sjrl

@sjrl sjrl commented Oct 16, 2026

Copy link
Copy Markdown
Contributor

Related Issues

Proposed Changes:

  • Add a paragraph to the BranchJoiner docstring saying only one connected branch should produce output per run, and pointing to ListJoiner/DocumentJoiner for collecting several branches
  • Add the same guidance to the BranchJoiner docs page overview

How did you test it?

Docs-only change; ran hatch run fmt.

Notes for the reviewer

No release note since this only changes docs.

Checklist

  • I have read the contributors guidelines and the code of conduct.
  • I have updated the related issue with new insights and changes.
  • I've used one of the conventional commit types for my PR title: fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, test: and added ! in case the PR includes breaking changes.

@sjrl
sjrl requested a review from a team as a code owner October 16, 2026 06:40
@sjrl
sjrl requested review from julian-risch and removed request for a team October 16, 2026 06:40
@vercel

vercel Bot commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
haystack-docs Ready Ready Preview Oct 16, 2026 6:45am UTC

Request Review

@sjrl sjrl self-assigned this Oct 16, 2026
@github-actions github-actions Bot added the type:documentation Improvements on the docs label Oct 16, 2026
@sjrl
sjrl enabled auto-merge (squash) October 16, 2026 06:42
@github-actions

Copy link
Copy Markdown
Contributor

Coverage report

This PR does not seem to contain any modification to coverable code.

@sjrl
sjrl merged commit ab590e6 into main Oct 16, 2026
25 checks passed
@sjrl
sjrl deleted the docs/branchjoiner-single-branch branch October 16, 2026 06:53

This branch was successfully deployed

1 active deployment
Preview — 4e50067d Deployed Oct 16, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type:documentation Improvements on the docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants